Summarize a population-level design forecast
Source:R/api-prediction.R
summary.mfrm_population_prediction.RdSummarize a population-level design forecast
Usage
# S3 method for class 'mfrm_population_prediction'
summary(object, digits = 3, ...)Arguments
- object
Output from
predict_mfrm_population().- digits
Number of digits used in numeric summaries.
- ...
Reserved for generic compatibility.
Value
An object of class summary.mfrm_population_prediction with:
design: requested future designoverview: run-level overviewforecast: facet-level forecast tablefacet_names: public non-person facet names used in the forecastdesign_variable_aliases: public aliases for design variablesdesign_descriptor: role-based description of design variablesplanning_scope: explicit record of the current planning contractplanning_constraints: explicit record of mutable/locked design variablesplanning_schema: combined planner-schema contractgpcm_boundary: bounded-GPCMcaveat row when presentfuture_branch_active_summary: compact deterministic summary of the schema-only future arbitrary-facet planning branch embedded in the current planning schemaademp: simulation-study metadatanotes: interpretation notes
Examples
if (FALSE) { # \dontrun{
spec <- build_mfrm_sim_spec(
n_person = 16,
n_rater = 3,
n_criterion = 2,
raters_per_person = 2,
assignment = "rotating"
)
pred <- predict_mfrm_population(
sim_spec = spec,
design = list(person = 18),
reps = 1,
maxit = 30,
seed = 123
)
s <- summary(pred)
s$overview
s$forecast[, c("Facet", "MeanSeparation", "McseSeparation")]
} # }