% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/help_visual_diagnostics.R
\name{visual_reporting_template}
\alias{visual_reporting_template}
\title{Figure-reporting template for visual diagnostics}
\usage{
visual_reporting_template(
  scope = c("all", "manuscript", "appendix", "diagnostic", "surface")
)
}
\arguments{
\item{scope}{Which part of the template to return: \code{"all"} (default),
\code{"manuscript"}, \code{"appendix"}, \code{"diagnostic"}, or \code{"surface"}.}
}
\value{
A data.frame with columns:
\itemize{
\item \code{FigureFamily}: short visual family label.
\item \code{Scope}: broad reporting role used for filtering.
\item \code{PrimaryHelper}: public helper or plot route.
\item \code{DefaultPlacement}: recommended location in a report.
\item \code{WhatToReport}: wording focus for results sections or captions.
\item \code{CaptionSkeleton}: caption starter that must be tailored to the study.
\item \code{ResultsWording}: results-sentence starter that must be checked against
the fitted object and diagnostics.
\item \code{WhatNotToClaim}: common overclaim to avoid.
\item \code{BeginnerCheck}: first thing a new user should inspect.
\item \code{ThreeDPolicy}: whether 3D is recommended, discouraged, or data-only.
}
}
\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
\code{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?".
}
\details{
This helper is intentionally conservative. It does not inspect a fitted
object and does not certify that a plot is available. Run
\code{\link[=reporting_checklist]{reporting_checklist()}} for run-specific readiness, then use this table to
decide how to describe the resulting figure.
}
\examples{
visual_reporting_template()
visual_reporting_template("manuscript")
visual_reporting_template("surface")
mfrmr_interval_guide("visual")[, c("Route", "PrimaryHelper", "DefaultLevel")]
}
\concept{figure captions}
\concept{reporting workflow}
\concept{visual diagnostics}
