defineInternalMetric: Define an internal metric for lcModels

View source: R/metricsInternal.R

defineInternalMetricR Documentation

Define an internal metric for lcModels

Description

Define an internal metric for lcModels

Usage

defineInternalMetric(
  name,
  fun,
  warnIfExists = getOption("latrend.warnMetricOverride", TRUE)
)

Arguments

name

The name of the metric.

fun

The function to compute the metric, accepting a lcModel object as input.

warnIfExists

Whether to output a warning when the metric is already defined.

See Also

Other metric functions: defineExternalMetric(), externalMetric,lcModel,lcModel-method, getExternalMetricDefinition(), getExternalMetricNames(), getInternalMetricDefinition(), getInternalMetricNames(), metric()

Examples

defineInternalMetric("BIC", fun = BIC)

mae <- function(object) {
  mean(abs(residuals(object)))
}
defineInternalMetric("MAE", fun = mae)

latrend documentation built on March 31, 2023, 5:45 p.m.