Skip to contents

Metric Framework Constants

Source: R/metric-constants.R
metric-constants.Rd

Provides the authoritative reference for the 16-metric benchmark framework used across the Artalytics platform. Use these functions to access official metric names, categories, and source mappings when building reports, UI displays, or validation logic.

**Why these exist:** Centralized metric definitions prevent naming inconsistencies across packages and ensure UI labels match database columns. The framework is version-controlled here as the single source of truth.

Usage

get_categories()

get_metric_definitions()

get_artbenchmark_metrics()

get_extended_metrics()

get_metric_name(metric_key)

get_metric_category(metric_key)

Arguments

metric_key

Character. The database column name

Value

- `get_categories()`: Character vector of the three category names - `get_metric_definitions()`: data.table with columns `category`, `metric_key`, `metric_name`, `source`, and `description` for all 16 metrics - `get_artbenchmark_metrics()`: Character vector of metric keys computed by this package (source = "image_analysis") - `get_extended_metrics()`: Character vector of extended metric keys stored but not used in core benchmarks - `get_metric_name()`: Character scalar with the official display name - `get_metric_category()`: Character scalar with the category name, or NA if metric not found

Functions

  • get_categories(): Get official category names

  • get_metric_definitions(): Get metric definitions with official naming

  • get_artbenchmark_metrics(): Get metrics computed by artbenchmark (image analysis)

  • get_extended_metrics(): Get extended metrics (stored but not in core benchmarks)

  • get_metric_name(): Lookup official name for a metric key

  • get_metric_category(): Lookup category for a metric key

See also

Other metrics: calc_art_metrics(), get_image_rast()

Examples

if (FALSE) { # \dontrun{
# Get all three category names
categories <- get_categories()
# Returns: c("time_effort", "skill_artistry", "complex_detail")

# Get complete metric framework
defs <- get_metric_definitions()
# 16 rows with category, key, name, source, description

# Check which metrics artbenchmark computes
image_metrics <- get_artbenchmark_metrics()
# Returns: c("canvas_coverage", "ave_blend_rate", "n_unique_colors", ...)

# Get display name for a metric
get_metric_name("canvas_coverage")
# Returns: "Canvas Coverage"

# Get category for a metric
get_metric_category("n_unique_colors")
# Returns: "skill_artistry"
} # }