Package: WMFM 1.0.4

James Curran

WMFM: Explore Fitted Linear and Generalised Linear Models with 'shiny'

Provides a 'shiny' application that helps learners connect regression tables to fitted generalised linear models. Users construct models via drag-and-drop controls, obtain fitted equations and plain-language explanations generated by a large language model, and can view plots of the fitted model in settings with a single continuous covariate.

Authors:James Curran [aut, cre]

WMFM_1.0.4.tar.gz
WMFM_1.0.4.tar.gz(r-4.7-any)WMFM_1.0.4.tar.gz(r-4.6-any)
WMFM_1.0.4.tgz(r-4.6-emscripten)
manual.pdf |manual.html
DESCRIPTION |NEWS
card.svg |card.png
WMFM/json (API)

# Install 'WMFM' in R:
install.packages('WMFM', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/jmcurran/wmfm/issues

On CRAN:

Conda:

1.70 score 2 scripts 79 exports 92 dependencies

Last updated from:de460ecafd. Checks:4 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK242
source / vignettesOK229
linux-release-x86_64OK228
wasm-releaseOK170

Exports:addDerivedVariableToDataauditBadExplanationGradingbuildExplanationClaimEvidenceMapbuildExplanationTeachingSummarybuildModelPlotDatabuildScalePhrasingRulesbuildWmfmRunRecordchooseFactorLayoutclassifyEffectScaleClaimcleanExplanationTextcomparecomputeFactorOnlyContrastcomputeMeanCicountWmfmSentencescountWmfmWordsdescribeFielddescribeWmfmFielddetectImplicitComparisondetectRangeExpressiondetectWmfmPatterndiagnosediagnoseExplanationSurfaceProcessingeditWmfmConfigexplainWmfmFieldScoreextractWmfmTextfindExplanationSurfaceIssuesformatSummaryValueformatWmfmElapsedTimegenerateBadExplanationgetFactorPredictorsgetMetricComparisonDatagetModelEquationsgetWmfmClaimColorMapgetWmfmConfigDirgetWmfmConfigPathgetWmfmMetricRegistrygetWmfmRunsClaimProfileDatagetWmfmRunsClaimsDatagetWmfmRunsTextMetricsDatagradeisFactorOnlyModelisFactorOnlyPredictorModellistBadExplanationTypeslistWMFMExampleDetailslistWMFMExamplesmakeDeveloperModePasswordHashmakeFactorOnlyPlotmakeFittedMeansDatamakeMeanEquationmakeSafeEvalEnvmakeWmfmDeterministicCategoryColorsmakeWmfmLegendLabelsnewWmfmGradenewWmfmGradeListObjnewWmfmModelnewWmfmScoresnormaliseWmfmTextorderWmfmLegendValuesparseSingleAssignmentplotCiControlsUiplotModelPlotplotWmfmExplanationClaimHeatmapplotWmfmScoreAgreementSummaryplotWmfmScoreHeatmappostProcessExplanationTextreadWmfmConfigPathrebuildWmfmRunRecordsrenderOneWayTablerenderTwoWayTablerunExamplerunModelrunWMFMAppscorescoreWmfmRepeatedRunsscoreWmfmRunsWithLlmscoreWmfmRunWithLlmstabilitysummariseDeveloperScoringAuditsummariseMetricComparison

Dependencies:askpassassertthatbackportsbase64encbslibcachemcheckmateclicommonmarkcorocpp11crayoncurldigestdplyrellmerevaluatefarverfastmapfontawesomeforcatsfsgenericsGGallyggplot2ggrepelggstatsgluegtablehighrhmshtmltoolshtmlwidgetshttpuvhttr2isobandjquerylibjsonliteknitrlabelinglaterlatticelearnrlifecyclelitedownmagrittrmarkdownmemoisemimenlmeopensslotelpatchworkpillarpkgconfigprettyunitsprogresspromisespurrrR6rappdirsRColorBrewerRcpprenvrlangrmarkdownrprojrootrstudioapis20xS7sandwichsassscalesshinysodiumsortablesourcetoolsstringistringrsystibbletidyrtidyselecttinytexutf8vctrsviridisLitewithrxfunxtableyamlzoo

Readme and manuals

Help Manual

Help pageTopics
Add a derived variable to a data frame from a single assignment lineaddDerivedVariableToData
Coerce a WMFM scores object to a data frameas.data.frame.wmfmScores
Audit whether bad explanations are being penalised by the current rubricauditBadExplanationGrading
Build a deterministic claim-to-evidence map for a model explanationbuildExplanationClaimEvidenceMap
Build a student-facing teaching summary for a model explanationbuildExplanationTeachingSummary
Build deterministic model-plot databuildModelPlotData
Generate language rules for interpreting a linear contrastbuildScalePhrasingRules
Build a single WMFM repeated-run recordbuildWmfmRunRecord
Choose fitted-means table layout for 1–3 factor predictorschooseFactorLayout
Classify the effect scale described in a WMFM explanationclassifyEffectScaleClaim
Clean generated explanation text before deterministic processingcleanExplanationText
Compare WMFM objectscompare
Compare grading results for wmfmGrade objectscompare.wmfmGrade
Compare WMFM score resultscompare.wmfmScores
Compute a single contrast for factor-only modelscomputeFactorOnlyContrast
Compute confidence intervals for fitted mean responsescomputeMeanCi
Count sentences in textcountWmfmSentences
Count words in textcountWmfmWords
Describe a field for a WMFM objectdescribeField
Describe a field for a WMFM runs objectdescribeField.wmfmRuns
Describe a field for a WMFM scores objectdescribeField.wmfmScores
Describe a WMFM fielddescribeWmfmField
Detect implicit comparison language in WMFM explanationsdetectImplicitComparison
Detect numeric range expressions (implicit uncertainty)detectRangeExpression
Detect pattern in textdetectWmfmPattern
Diagnose scoring disagreementdiagnose
Diagnose disagreement for a WMFM scores objectdiagnose.wmfmScores
Diagnose deterministic explanation surface processingdiagnoseExplanationSurfaceProcessing
Edit the WMFM local configuration fileeditWmfmConfig
Explain why a WMFM field received its score for a specific runexplainWmfmFieldScore
Extract text from WMFM output objectsextractWmfmText
Fill missing predictor columns in new data using the model's training framefillMissingPredictors
Find remaining surface-language issues in explanation textfindExplanationSurfaceIssues
Format a numeric summary value for displayformatSummaryValue
Format elapsed time for WMFM progress messagesformatWmfmElapsedTime
Generate one or more deliberately bad model explanationsgenerateBadExplanation generateBadExplanation.wmfmModel
Extract factor predictors from a fitted modelgetFactorPredictors
Extract run-level comparison data for a metricgetMetricComparisonData
Get fitted-model equations using the selected equation enginegetModelEquations
Get the default WMFM claim colour mapgetWmfmClaimColorMap
Get the WMFM local configuration directorygetWmfmConfigDir
Get the WMFM local configuration file pathgetWmfmConfigPath
Return the WMFM metric registrygetWmfmMetricRegistry
Build claim-profile heatmap data for a WMFM runs objectgetWmfmRunsClaimProfileData
Build extracted-claim frequency data for a WMFM runs objectgetWmfmRunsClaimsData
Build per-run text and timing metric data for a WMFM runs objectgetWmfmRunsTextMetricsData
Grade WMFM objectsgrade
Grade one or more explanations against a WMFM modelgrade.wmfmModel
Check whether a fitted model has only factor predictorsisFactorOnlyModel
Detect factor-only predictor modelsisFactorOnlyPredictorModel
List supported bad explanation typeslistBadExplanationTypes
List packaged WMFM example detailslistWMFMExampleDetails
List packaged WMFM exampleslistWMFMExamples
Create a developer-mode password hashmakeDeveloperModePasswordHash
Plot response by factor predictors for factor-only modelsmakeFactorOnlyPlot
Build fitted means for factor-only predictor modelsmakeFittedMeansData
Construct a fitted-mean equation from model coefficientsmakeMeanEquation
Create a safe evaluation environment for derived-variable expressionsmakeSafeEvalEnv
Make deterministic category colours for WMFM heatmapsmakeWmfmDeterministicCategoryColors
Make readable WMFM legend labelsmakeWmfmLegendLabels
Create a WMFM grade objectnewWmfmGrade
Create a WMFM grade list objectnewWmfmGradeListObj
Create a WMFM model objectnewWmfmModel
Create an empty WMFM scores objectnewWmfmScores
Normalise text for comparisonnormaliseWmfmText
Order WMFM legend valuesorderWmfmLegendValues
Parse a single assignment statement from textparseSingleAssignment
Plot a metric comparison data objectplot.metricComparisonData
Plot a metric comparison summaryplot.metricComparisonSummary
Plot a WMFM runs objectplot.wmfmRuns
Plot a WMFM score comparison objectplot.wmfmScoreComparison
Plot a WMFM scores objectplot.wmfmScores
Plot a WMFM score stability objectplot.wmfmScoreStability
Plot CI controls for the Plot tabplotCiControlsUi
Draw a student-facing model plotplotModelPlot
Plot a raw-claim heatmap for WMFM runsplotWmfmExplanationClaimHeatmap
Plot ordinal agreement summary for WMFM score comparisonplotWmfmScoreAgreementSummary
Plot a run-level disagreement heatmap for WMFM score comparisonsplotWmfmScoreHeatmap
Post-process generated explanation text before displaypostProcessExplanationText
Print a metric comparison summaryprint.metricComparisonSummary
Print a WMFM grade summaryprint.summary.wmfmGrade
Print a WMFM grade list summaryprint.summary.wmfmGradeListObj
Print a summary.wmfmRuns objectprint.summary.wmfmRuns
Print a bad explanation grading auditprint.wmfmBadExplanationAudit
Print a deterministic equation tableprint.wmfmEquationTable
Print a WMFM explanation auditprint.wmfmExplanationAudit
Print an explanation surface diagnosisprint.wmfmExplanationSurfaceDiagnosis
Print a WMFM grade objectprint.wmfmGrade
Print a wmfmGradeComparison objectprint.wmfmGradeComparison
Print a WMFM grade list objectprint.wmfmGradeListObj
Print a metric diagnosis objectprint.wmfmMetricDiagnosis
Print a WMFM score comparison objectprint.wmfmScoreComparison
Print a scores diagnosis objectprint.wmfmScoresDiagnosis
Print a WMFM score stability objectprint.wmfmScoreStability
Read the WMFM local configuration file pathreadWmfmConfigPath
Rebuild raw WMFM run records without rerunning the LLMrebuildWmfmRunRecords
Render a one-way fitted-means table as HTML tagsrenderOneWayTable
Render a two-way fitted-means table as HTML tagsrenderTwoWayTable
Run a packaged WMFM example one or more timesrunExample
Fit a WMFM model and generate command-line outputsrunModel
Run the Model Builder apprunWMFMApp
Score WMFM objectsscore
Score a WMFM grade objectscore.wmfmGrade
Score a WMFM grade list objectscore.wmfmGradeListObj
Score a WMFM runs objectscore.wmfmRuns
Score repeated WMFM explanation runs using a multidimensional rubricscoreWmfmRepeatedRuns
Score multiple WMFM runs using an LLMscoreWmfmRunsWithLlm
Score a single WMFM run record using a language modelscoreWmfmRunWithLlm
Assess stability of WMFM objectsstability
Assess stability of WMFM score resultsstability.wmfmScores
Summarise repeated developer scoring fixture stabilitysummariseDeveloperScoringAudit
Summarise metric-level comparison and deterministic easesummariseMetricComparison
Summarise a WMFM grade objectsummary.wmfmGrade
Summarise a WMFM grade list objectsummary.wmfmGradeListObj
Summarise a WMFM runs objectsummary.wmfmRuns