visual_reporting_template: Figure-reporting template for visual diagnostics

In mfrmr: Estimation and Diagnostics for Many-Facet Measurement Models

Figure-reporting template for visual diagnostics

Description

Return a compact, beginner-oriented template that explains where each visual family normally belongs in a report, which helper to call, what to say, and what not to claim. Use this static table together with the dynamic reporting_checklist(fit, diagnostics)$visual_scope table: the template answers "how should I use this figure?", while the checklist answers "is this figure ready for the current run?".

Usage

visual_reporting_template(
  scope = c("all", "manuscript", "appendix", "diagnostic", "surface")
)

Arguments

scope

Which part of the template to return: "all" (default), "manuscript", "appendix", "diagnostic", or "surface".

Details

This helper is intentionally conservative. It does not inspect a fitted object and does not certify that a plot is available. Run reporting_checklist() for run-specific readiness, then use this table to decide how to describe the resulting figure.

Value

A data.frame with columns:

• FigureFamily: short visual family label.

• Scope: broad reporting role used for filtering.

• PrimaryHelper: public helper or plot route.

• DefaultPlacement: recommended location in a report.

• WhatToReport: wording focus for results sections or captions.

• CaptionSkeleton: caption starter that must be tailored to the study.

• ResultsWording: results-sentence starter that must be checked against the fitted object and diagnostics.

• WhatNotToClaim: common overclaim to avoid.

• BeginnerCheck: first thing a new user should inspect.

• ThreeDPolicy: whether 3D is recommended, discouraged, or data-only.

Examples

visual_reporting_template()
visual_reporting_template("manuscript")
visual_reporting_template("surface")
mfrmr_interval_guide("visual")[, c("Route", "PrimaryHelper", "DefaultLevel")]

mfrmr documentation built on June 13, 2026, 1:07 a.m.