# Explore Fitted Linear and Generalised Linear Models with 'shiny'

## Documentation for package ‘WMFM’ version 1.1.4

- DESCRIPTION file
- Package NEWS
- Package README

## Help Pages

A B C D E F G I L M N O P R S

## -- A --

addDerivedVariableToData | Add a derived variable to a data frame from a single assignment line
as.data.frame.wmfmScores | Coerce a WMFM scores object to a data frame
auditBadExplanationGrading | Audit whether bad explanations are being penalised by the current rubric

## -- B --

buildExplanationClaimEvidenceMap | Build a deterministic claim-to-evidence map for a model explanation
buildExplanationTeachingSummary | Build a student-facing teaching summary for a model explanation
buildModelPlotData | Build deterministic model-plot data
buildScalePhrasingRules | Generate language rules for interpreting a linear contrast
buildWmfmRunRecord | Build a single WMFM repeated-run record

## -- C --

chooseFactorLayout | Choose fitted-means table layout for 1–3 factor predictors
classifyEffectScaleClaim | Classify the effect scale described in a WMFM explanation
cleanExplanationText | Clean generated explanation text before deterministic processing
compare | Compare WMFM objects
compare.wmfmGrade | Compare grading results for wmfmGrade objects
compare.wmfmScores | Compare WMFM score results
computeFactorOnlyContrast | Compute a single contrast for factor-only models
computeMeanCi | Compute confidence intervals for fitted mean responses
countWmfmSentences | Count sentences in text
countWmfmWords | Count words in text

## -- D --

describeField | Describe a field for a WMFM object
describeField.wmfmRuns | Describe a field for a WMFM runs object
describeField.wmfmScores | Describe a field for a WMFM scores object
describeWmfmField | Describe a WMFM field
detectImplicitComparison | Detect implicit comparison language in WMFM explanations
detectRangeExpression | Detect numeric range expressions (implicit uncertainty)
detectWmfmPattern | Detect pattern in text
diagnose | Diagnose scoring disagreement
diagnose.wmfmScores | Diagnose disagreement for a WMFM scores object
diagnoseExplanationSurfaceProcessing | Diagnose deterministic explanation surface processing

## -- E --

editWmfmConfig | Edit the WMFM local configuration file
explainWmfmFieldScore | Explain why a WMFM field received its score for a specific run
extractWmfmText | Extract text from WMFM output objects

## -- F --

fillMissingPredictors | Fill missing predictor columns in new data using the model's training frame
findExplanationSurfaceIssues | Find remaining surface-language issues in explanation text
formatSummaryValue | Format a numeric summary value for display
formatWmfmElapsedTime | Format elapsed time for WMFM progress messages

## -- G --

generateBadExplanation | Generate one or more deliberately bad model explanations
generateBadExplanation.wmfmModel | Generate one or more deliberately bad model explanations
getFactorPredictors | Extract factor predictors from a fitted model
getMetricComparisonData | Extract run-level comparison data for a metric
getModelEquations | Get fitted-model equations using the selected equation engine
getWmfmClaimColorMap | Get the default WMFM claim colour map
getWmfmConfigDir | Get the WMFM local configuration directory
getWmfmConfigPath | Get the WMFM local configuration file path
getWmfmMetricRegistry | Return the WMFM metric registry
getWmfmRunsClaimProfileData | Build claim-profile heatmap data for a WMFM runs object
getWmfmRunsClaimsData | Build extracted-claim frequency data for a WMFM runs object
getWmfmRunsTextMetricsData | Build per-run text and timing metric data for a WMFM runs object
grade | Grade WMFM objects
grade.wmfmModel | Grade one or more explanations against a WMFM model

## -- I --

isFactorOnlyModel | Check whether a fitted model has only factor predictors
isFactorOnlyPredictorModel | Detect factor-only predictor models

## -- L --

listBadExplanationTypes | List supported bad explanation types
listWMFMEvaluationExamples | List WMFM evaluation examples
listWMFMExampleDetails | List packaged WMFM example details
listWMFMExamples | List packaged WMFM examples

## -- M --

makeDeveloperModePasswordHash | Create a developer-mode password hash
makeFactorOnlyPlot | Plot response by factor predictors for factor-only models
makeFittedMeansData | Build fitted means for factor-only predictor models
makeMeanEquation | Construct a fitted-mean equation from model coefficients
makeSafeEvalEnv | Create a safe evaluation environment for derived-variable expressions
makeWmfmDeterministicCategoryColors | Make deterministic category colours for WMFM heatmaps
makeWmfmLegendLabels | Make readable WMFM legend labels
modelConfidenceIntervals | Build the student-facing WMFM confidence-interval table

## -- N --

newWmfmGrade | Create a WMFM grade object
newWmfmGradeListObj | Create a WMFM grade list object
newWmfmModel | Create a WMFM model object
newWmfmScores | Create an empty WMFM scores object
normaliseWmfmText | Normalise text for comparison

## -- O --

orderWmfmLegendValues | Order WMFM legend values

## -- P --

parseSingleAssignment | Parse a single assignment statement from text
plot.metricComparisonData | Plot a metric comparison data object
plot.metricComparisonSummary | Plot a metric comparison summary
plot.wmfmRuns | Plot a WMFM runs object
plot.wmfmScoreComparison | Plot a WMFM score comparison object
plot.wmfmScores | Plot a WMFM scores object
plot.wmfmScoreStability | Plot a WMFM score stability object
plotCiControlsUi | Plot CI controls for the Plot tab
plotModelPlot | Draw a student-facing model plot
plotWmfmExplanationClaimHeatmap | Plot a raw-claim heatmap for WMFM runs
plotWmfmScoreAgreementSummary | Plot ordinal agreement summary for WMFM score comparison
plotWmfmScoreHeatmap | Plot a run-level disagreement heatmap for WMFM score comparisons
postProcessExplanationText | Post-process generated explanation text before display
print.metricComparisonSummary | Print a metric comparison summary
print.summary.wmfmGrade | Print a WMFM grade summary
print.summary.wmfmGradeListObj | Print a WMFM grade list summary
print.summary.wmfmRuns | Print a summary.wmfmRuns object
print.wmfmBadExplanationAudit | Print a bad explanation grading audit
print.wmfmEquationTable | Print a deterministic equation table
print.wmfmExplanationAudit | Print a WMFM explanation audit
print.wmfmExplanationSurfaceDiagnosis | Print an explanation surface diagnosis
print.wmfmGrade | Print a WMFM grade object
print.wmfmGradeComparison | Print a wmfmGradeComparison object
print.wmfmGradeListObj | Print a WMFM grade list object
print.wmfmMetricDiagnosis | Print a metric diagnosis object
print.wmfmScoreComparison | Print a WMFM score comparison object
print.wmfmScoresDiagnosis | Print a scores diagnosis object
print.wmfmScoreStability | Print a WMFM score stability object

## -- R --

readWmfmConfigPath | Read the WMFM local configuration file path
rebuildWmfmRunRecords | Rebuild raw WMFM run records without rerunning the LLM
renderOneWayTable | Render a one-way fitted-means table as HTML tags
renderTwoWayTable | Render a two-way fitted-means table as HTML tags
runExample | Run a packaged WMFM example one or more times
runModel | Fit a WMFM model and generate command-line outputs
runWMFMApp | Run the Model Builder app
runWMFMEvaluationSuite | Run a WMFM example evaluation suite

## -- S --

score | Score WMFM objects
score.wmfmGrade | Score a WMFM grade object
score.wmfmGradeListObj | Score a WMFM grade list object
score.wmfmRuns | Score a WMFM runs object
scoreWmfmRepeatedRuns | Score repeated WMFM explanation runs using a multidimensional rubric
scoreWmfmRunsWithLlm | Score multiple WMFM runs using an LLM
scoreWmfmRunWithLlm | Score a single WMFM run record using a language model
stability | Assess stability of WMFM objects
stability.wmfmScores | Assess stability of WMFM score results
summariseDeveloperScoringAudit | Summarise repeated developer scoring fixture stability
summariseMetricComparison | Summarise metric-level comparison and deterministic ease
summary.wmfmGrade | Summarise a WMFM grade object
summary.wmfmGradeListObj | Summarise a WMFM grade list object
summary.wmfmRuns | Summarise a WMFM runs object