mfrm_threshold_profiles: List literature-based warning threshold profiles

View source: R/api-reports.R

mfrm_threshold_profilesR Documentation

List literature-based warning threshold profiles

Description

List literature-based warning threshold profiles

Usage

mfrm_threshold_profiles()

Details

Use this function to inspect available profile presets before calling build_visual_summaries().

profiles contains thresholds used by warning logic (sample size, fit ratios, PCA cutoffs, etc.). pca_reference_bands contains literature-oriented descriptive bands used in summary text.

Value

An object of class mfrm_threshold_profiles with profiles (strict, standard, lenient) and pca_reference_bands.

Interpreting output

  • profiles: numeric threshold presets (strict, standard, lenient).

  • pca_reference_bands: narrative reference bands for PCA interpretation.

Typical workflow

  1. Review presets with mfrm_threshold_profiles().

  2. Pick a default profile for project policy.

  3. Override only selected fields in build_visual_summaries() when needed.

See Also

build_visual_summaries()

Examples

profiles <- mfrm_threshold_profiles()
names(profiles)
names(profiles$profiles)
class(profiles)
s_profiles <- summary(profiles)
s_profiles$overview

mfrmr documentation built on March 31, 2026, 1:06 a.m.