Guidance changes only which stored advice is displayed. "default" shows
severity 3-4 advice and counts hidden severity 1-2 notes; "important"
and its compatibility alias "quiet" show severity 3-4 advice only;
"teaching" shows severity 1-4 advice with external citations and recorded
rationale; "strict" shows severity 1-4 advice in compact prose; and
"off" hides automatic advice. Severity 0 remains audit-only.
When a result has only one non-audit advice entry, that entry is shown under
every profile except "off" instead of being reported as hidden.
Details
Guidance is a session-level display setting read when a stored result is
printed. Call simtablr_guidance() separately; do not place it inside the
... of table1() or tb(). Changing guidance does not recompute results.
See also
simtablr_references for the full references behind the citations shown in advice.
Examples
previous <- simtablr_guidance()
result <- table1(epitabl, "sex")
simtablr_guidance("teaching")
print(result)
#> Characteristic Overall (N=1500)
#> -------------------------------------------------------------
#> Sex recorded for clinical assessment, n (%)
#> Female 686 (45.7%)
#> Male 814 (54.3%)
simtablr_guidance(previous)
suppressMessages(print(result))
#> Characteristic Overall (N=1500)
#> -------------------------------------------------------------
#> Sex recorded for clinical assessment, n (%)
#> Female 686 (45.7%)
#> Male 814 (54.3%)