Skip to contents

Summarize a legacy-compatible workflow run

Source: R/facets_mode_methods.R
summary.mfrm_facets_run.Rd

Summarize a legacy-compatible workflow run

Usage

# S3 method for class 'mfrm_facets_run'
summary(object, digits = 3, top_n = 10, ...)

Arguments

object

Output from run_mfrm_facets().

digits

Number of digits for numeric rounding in summaries.

top_n

Maximum rows shown in nested preview tables.

...

Passed through to nested summary methods.

Value

An object of class summary.mfrm_facets_run.

Details

This method returns a compact cross-object summary that combines:

  • model overview (object$fit$summary)

  • resolved column mapping

  • run settings (run_info)

  • nested summaries of fit and diagnostics

Interpreting output

  • overview: convergence, information criteria, and scale size.

  • mapping: sanity check for auto/explicit column mapping.

  • fit / diagnostics: drill-down summaries for reporting decisions.

Typical workflow

  1. Run run_mfrm_facets() to execute a one-shot pipeline.

  2. Inspect with summary(out) for mapping and convergence checks.

  3. Review nested objects (out$fit, out$diagnostics) as needed.

See also

run_mfrm_facets(), summary.mfrm_fit(), mfrmr_workflow_methods, summary()

Examples

toy <- load_mfrmr_data("example_core")
toy_small <- toy[toy$Person %in% unique(toy$Person)[1:12], , drop = FALSE]
out <- run_mfrm_facets(
  data = toy_small,
  person = "Person",
  facets = c("Rater", "Criterion"),
  score = "Score",
  maxit = 10
)
#> Warning: Optimizer did not fully converge (code = 1). Consider increasing maxit (current: 10) or relaxing reltol (current: 1e-06).
s <- summary(out)
s$overview[, c("Model", "Method", "Converged")]
#> # A tibble: 1 × 3
#>   Model Method Converged
#>   <chr> <chr>  <lgl>    
#> 1 RSM   JMLE   FALSE    
s$mapping
#> # A tibble: 4 × 2
#>   Key    Value             
#>   <chr>  <chr>             
#> 1 Person "Person"          
#> 2 Score  "Score"           
#> 3 Facets "Rater, Criterion"
#> 4 Weight ""