Man pages for summata
Publication-Ready Summary Tables and Forest Plots

add_header_paddingAdd padding to exported table headers
add_pvalue_columnAdd _p_-value column to result table
add_raw_statsAdd raw statistics to row
add_variable_paddingAdd padding to exported table variables
apply_decimal_markApply locale decimal mark to a sprintf-formatted string
apply_zebra_stripes_ftApply zebra stripes with proper variable group detection for...
autoforestCreate Forest Plot with Automatic Model Detection
autotableExport Table with Automatic Format Detection
bold_pvalues_ftBold significant _p_-values in DOCX
build_failed_model_rowBuild row for failed model
build_model_rowBuild comparison row for successfully fitted model
calculate_coxme_scoresCalculate scores for mixed-effects Cox models
calculate_forest_layoutCalculate table layout for forest plots
calculate_glmer_scoresCalculate scores for generalized linear mixed-effects models
calculate_lmer_scoresCalculate scores for linear mixed-effects models
calculate_model_scoresCalculate Composite Mean Scores (CMS) for model comparison
calculate_multiforest_layoutCalculate table layout for multiforest plots
calculate_table_widthCalculate table width based on paper size and orientation
calculate_uniforest_layoutCalculate table layout for uniforest plots
check_convergenceCheck model convergence
check_latexCheck LaTeX installation
check_required_packagesCheck required packages for model type
clintrialSimulated Clinical Trial Dataset
clintrial_labelsVariable Labels for Clinical Trial Dataset
combine_coefficient_tablesCombine coefficient tables from multiple models
combine_multifit_resultsCombine multivariate results
compfitCompare Multiple Regression Models
condense_quantitative_rowsCondense quantitative variable rows only
condense_table_rowsCondense table rows for more compact display
convert_unitsConvert between units
coxforestCreate Forest Plot for Cox Proportional Hazards Models
desctableCreate Publication-Ready Descriptive Statistics Tables
detect_model_typeDetect if model is univariable or multivariable
detect_model_type_autoAuto-detect model type based on outcome and random effects
detect_outcome_typeDetect outcome type from data
detect_plot_fontDetect available sans-serif font for plots
determine_alignmentDetermine alignment for exported tables
determine_effect_typeDetermine Effect Type Label
extract_coxme_metricsExtract metrics for mixed-effects Cox models (coxme)
extract_glmer_metricsExtract metrics for generalized linear mixed-effects models...
extract_lmer_metricsExtract metrics for linear mixed-effects models (lmer)
extract_model_metricsExtract comprehensive model metrics based on academic...
extract_predictor_effectsExtract predictor effects from a fitted model
finalize_column_namesFinalize Column Names for Display
find_non_reference_rowFind non-reference row for binary variable condensing
fitFit Regression Model with Publication-Ready Output
fix_negative_zeroFix negative zero in formatted strings
forest_ci_separatorDetermine CI separator for forest plot text annotations
format_categorical_statFormat a categorical statistic for display
format_column_headersApply formatting to column headers in exported tables...
format_column_headers_htmlApply formatting to column headers in exported tables (HTML)
format_column_headers_with_n_htmlFormat column headers with n counts (HTML)
format_column_headers_with_n_texFormat column headers with n counts (TeX)
format_continuous_statFormat continuous statistic for display
format_countFormat an integer count with locale-aware thousands separator
format_count_forestFormat an integer for forest plot annotations
format_fullfit_combinedFormat combined fullfit output from formatted tables
format_headers_ftFormat headers for flextable
format_indented_groupsApply formatting to indented groups
format_interaction_termFormat interaction term for display
format_model_comparisonFormat model comparison table
format_model_tableFormat model results for publication-ready display
format_multifit_tableFormat multifit results for publication
format_numFormat a numeric value with locale-aware separators
format_numberFormat numeric value with fixed decimal places
format_p_forestFormat a p-value for forest plot annotations
format_pvalueFormat a _p_-value with locale-aware decimal mark
format_pvalues_desctableFormat _p_-values for descriptive tables
format_pvalues_export_htmlFormat _p_-values for exported tables (HTML)
format_pvalues_export_texFormat _p_-values for exported tables
format_pvalues_fitFormat _p_-values for display
format_pvalues_multifitFormat p-values for multifit display
format_pvalue_survtableFormat _p_-value for survtable
format_quantile_cellsVectorized quantile cell formatting
format_survival_cellsVectorized survival cell formatting
format_survival_ciFormat survival median with CI for display
fullfitComplete Regression Analysis Workflow
get_cached_confintRetrieve confidence intervals with cache support
get_event_variableExtract event variable from survival model
get_model_dataGet data from model object (works with S3 and S4)
get_model_type_nameGet readable model type name
get_model_xlevelsGet factor levels from model (works with S3 and S4)
get_paper_settingsGet paper size for PDF/LaTeX export
get_stat_labelGet display label for statistic type
glmforestCreate Forest Plot for Generalized Linear Models
identify_variable_groupsIdentify variable groups before indentation
is_affirmative_categoryCheck if category name should be suppressed in condensed...
is_multifit_resultCheck if object is a multifit result
is_reference_categoryCheck if category name is a standard reference/negative value
is_surv_outcomeCheck if outcome is a Surv() expression
is_uniscreen_resultCheck if object is a uniscreen result
lmforestCreate Forest Plot for Linear Models
m2dtConvert Model to Data Table
multifitMultivariate Regression Analysis
multiforestCreate Forest Plot for Multivariate Regression
normalize_model_typeNormalize model type names
number_formatNumber Formatting Utilities
order_comparison_columnsOrder comparison columns based on model type
parse_termParse term into variable and group
perform_categorical_testPerform statistical tests for categorical variables
perform_continuous_testPerform statistical tests for continuous variables
perform_survival_testPerform survival comparison test
print.compfit_resultPrint method showing scoring methodology
print.fit_resultPrint method for fit results
print.fullfit_resultPrint method for fullfit results
print.multifit_resultPrint method for multifit results
print.survtablePrint method for survtable
print.table2docx_resultPrint method for table2docx results
print.table2pptx_resultPrint method for table2pptx results
print.table2rtf_resultPrint method for table2rtf results
print.uniscreen_resultPrint method for uniscreen results
process_categoricalProcess categorical variable
process_continuousProcess continuous variable
process_single_outcomeProcess a single survival outcome
process_survivalProcess survival variable
process_survival_probsProcess survival probability quantiles (optimized)
process_survival_timesProcess survival at specified time points (optimized)
process_table_for_flextableCore flextable processing function
process_variableProcess variable wrapper
quiet_fitFit a model with selective warning suppression
reorder_total_columnReorder columns to position total column
replace_empty_cellsReplace empty cells with "-"
resolve_number_marksResolve number format marks
resolve_separatorResolve the CI or range separator
safe_roundSafe rounding that handles 'NULL' and NA
sanitize_for_latexSanitize certain symbols for LaTeX
should_condense_binaryCheck if a binary variable should be condensed without...
summata-importsPackage Imports
survtableCreate Publication-Ready Survival Summary Tables
table2docxExport Table to Microsoft Word Format (DOCX)
table2htmlExport Table to HTML Format
table2pdfExport Table to PDF Format
table2pptxExport Table to Microsoft PowerPoint Format (PPTX)
table2rtfExport Table to Rich Text Format (RTF)
table2texExport Table to LaTeX Format
uniforestCreate Forest Plot for Univariable Screening
uniscreenUnivariable Screening for Multiple Predictors
validate_fit_inputsComplete input validation for fit functions
validate_model_outcomeValidate model type matches outcome specification
validate_number_formatValidate number_format parameter
validate_outcome_existsValidate outcome exists in data
validate_outcome_homogeneityValidate outcome homogeneity for multifit
validate_predictors_existValidate predictors exist in data
summata documentation built on May 7, 2026, 5:07 p.m.