recmetrics (version 0.1.0)

rec.average: REC Metric 1

Description

The average of the absolute values of the C-REC matrix entries (this is essentially how much relative excess correlation there is still to distribute across groupings)

Usage

rec.average(data, na.rm = TRUE)

Value

A single numerical value

Arguments

data

A data.frame or tibble (required)

na.rm

logical (defaults to TRUE)

Details

Examples

{
  # Use the SCWB data example
  # Metric 1 - item scores
  rec.average(SCWB[, 1:20])
  # Metric 4 - domain total scores
  my_rec <- rec.average(SCWB[, 21:25])
  my_rec
  # Metric 4 - averages
  mean(abs(my_rec[lower.tri(my_rec)]))
}