Package index

Prepare

Build a specification, shape the data, and set the design before computation.

simtab(): Start a SimtablR analysis specification
simtablr(): Build a manuscript-ready SimtablR report in one call
simtab_completions(): Opt-in RStudio autocomplete for SimtablR calls
describe(): Capture variables to describe
stratify(): Capture a stratifying variable
adjust(): Capture adjustment covariates
measure(): Set an effect measure
engine(): Select a registered computation engine
test(): Set a comparison test
set_summary(): Set the default summary statistic
overall(): Toggle the overall column
missingness(): Set missing-data policy
label(): Set display labels
fmt(): Set render formatting options
add_effect(): Add or replace the effect-measure column(s) of a table1
set_design(): Set study design metadata
design(): Read a recorded study design

Describe

Descriptive, baseline, and focused bivariate tables.

tb(): Cross-tabulate one or two variables
table1(): Describe a cohort across many variables (Table 1)
rbind(<simtab_tb>): Combine tb Objects by Rows

Compare and estimate

Effect estimation, regression, survival, and recorded revisions.

regtab(): Fit one regression model per outcome
survtab(): Fit a Cox proportional hazards model
coef(<simtab_result>) vcov(<simtab_result>) formula(<simtab_result>) nobs(<simtab_result>) confint(<simtab_result>): Access retained model evidence
model_info(): Inspect retained model convergence information
sensitivity() as_flextable(<simtab_sensitivity>): Recompute reviewer-loop sensitivity variations
e_value(): Compute E-values for SimtablR ratio estimates

Diagnose and validate

Diagnostic accuracy, ROC curves, and structural validation.

diag_test(): Assess the accuracy of a binary diagnostic test
roc(): Evaluate continuous markers with ROC curves
validate(): Validate a SimtablR specification before compute
plot(<simtab_diag>): Plot diagnostic test results

Render and export

Journal styling and output for HTML, Office, Excel, and data reuse.

style(): Set or update a SimtablR style
journal_style(): Create a SimtablR style / journal preset
as_gt(): Convert a SimtablR object to a gt table
as_flextable.simtab_result() as_flextable.simtab_spec() as_flextable.simtab_report(): Convert a SimtablR result or spec to a flextable
as_flextable.simtab_rbind_tb(): Convert simtab_rbind_tb Object to Flextable
as_flextable(<simtab_codebook>): Convert a SimtablR codebook to a flextable
as.data.frame(<simtab_result>) as.data.frame(<simtab_spec>): Convert a SimtablR result or spec to a data frame
as.data.frame(<simtab_report>): Coerce a SimtablR report to a data.frame
as.data.frame(<simtab_audit>): Coerce a SimtablR audit to a data.frame
as.data.frame(<simtab_rbind_tb>): Convert rbind_tb to Data Frame
print(<simtab_result>): Print a computed SimtablR result
print(<simtab_rbind_tb>): Print Method for simtab_rbind_tb Objects
autoplot(<simtab_result>): Autoplot a computed SimtablR result
autoplot(<simtab_spec>): Plot a computed SimtablR spec
tidy(<simtab_result>) tidy(<simtab_spec>): Tidy a SimtablR result
glance(<simtab_result>) glance(<simtab_spec>): Glance a SimtablR result
export_docx(): Export a SimtablR table to a Word (.docx) file
export_pptx(): Export a SimtablR table to a PowerPoint (.pptx) file
export_xlsx(): Export a SimtablR table to an Excel (.xlsx) file
export_plot(): Export a SimtablR plot to an image file
export_regtab_csv(): Export regtab results to CSV
export_regtab_xlsx(): Export regtab results to Excel

Explain and reproduce

Methods prose, methodological guidance, reporting checklists, flow, and reproducibility artifacts.

advise(): Run educator advice rules
why(): Report why SimtablR made each recorded decision
as_methods(): Generate a manuscript methods sentence
strobe() as_flextable(<simtab_checklist>): Build a STROBE reporting checklist
stard(): Build a STARD reporting checklist
codebook(): Build a SimtablR codebook
flow() as_flextable(<simtab_flow>) autoplot(<simtab_flow>): Build a participant flow table from recorded facts
simtablr_guidance(): Set or query SimtablR educator guidance
simtablr_references: References cited by SimtablR
repro_manifest(): Build a reproducibility manifest
is_simtab(): Test whether an object is a SimtablR result, optionally of a given preset
evaluate(): Evaluate a SimtablR analysis specification
simtab_errors: SimtablR condition classes