Man pages for surveyframe
Survey Instrument Workflows

add_modelAdd a model specification to an instrument
assumption_reportAssumption-check report
bootstrap_ciPercentile bootstrap confidence interval for a statistic
cfa_lavaan_syntaxGenerate lavaan CFA syntax
cfa_syntaxGenerate lavaan CFA syntax from an instrument object
codebook_reportGenerate a survey codebook from an instrument object
cohens_d_ciBootstrap confidence interval for Cohen's d
cramers_v_ciBootstrap confidence interval for Cramer's V
descriptives_reportDescriptive statistics report
efa_reportPrepare a survey instrument for exploratory factor analysis
efa_solutionEstimate an exploratory factor solution
efa_syntaxGenerate EFA planning syntax
eta_sq_ciBootstrap confidence interval for eta squared
export_google_sheetExport a survey instrument to Google Sheets collection format
export_static_surveyExport a self-contained static HTML survey
format.sf_branchFormat an sf_branch object as a string
format.sf_checkFormat an sf_check object as a string
format.sf_choicesFormat an sf_choices object as a string
format.sf_itemFormat an sf_item object as a string
format.sf_modelFormat an sf_model object as a string
format.sframeFormat an sframe instrument object as a string
format.sf_scaleFormat an sf_scale object as a string
item_reportGenerate item-level diagnostics
launch_builderLaunch the surveyframe visual survey builder
launch_builder_demoLaunch SurveyBuilder with the bundled input-types demo...
launch_dashboardLaunch the interactive response dashboard
launch_dashboard_demoLaunch the response dashboard with the bundled input-types...
launch_studioLaunch the SurveyStudio interface
launch_studio_demoLaunch SurveyStudio with the bundled input-types demo
missing_data_reportMissing-data report
model_jsonSerialise a model specification to JSON
model_report_templateCreate a model reporting template
outlier_reportFlag univariate and multivariate outliers
plot.sframe_analysis_resultsPlot analysis-plan results
posthoc_reportPost-hoc and pairwise comparison report
print.sf_branchPrint an sf_branch object
print.sf_checkPrint an sf_check object
print.sf_choicesPrint an sf_choices object
print.sf_itemPrint an sf_item object
print.sf_modelPrint an sf_model object
print.sframePrint an sframe instrument object
print.sf_scalePrint an sf_scale object
quality_reportGenerate a data quality report for survey responses
read_responsesRead and validate survey responses
read_sframeRead an instrument from a .sframe file
read_sheet_responsesRead survey responses from a Google Sheet
reliability_reportCompute reliability statistics for scored scales
render_reportRender a reproducible survey report
render_resultsRender analysis results to a formatted HTML report
render_surveyRender a survey from an instrument object
run_analysis_planRun a pre-planned analysis from an instrument's analysis plan
sample_size_planSample-size and power planning helper
score_scalesScore defined scales from survey responses
seminr_syntaxGenerate seminr PLS-SEM syntax
sem_lavaan_syntaxGenerate lavaan CB-SEM syntax
sf_branchDefine a branching rule
sf_checkDefine a design-time survey check
sf_choicesDefine a reusable choice set
sf_constructDefine a latent or composite construct
sf_covarianceDefine a covariance between constructs
sf_indirectDefine an indirect effect path
sf_instrumentCreate a survey instrument object
sf_itemDefine a survey item
sf_modelCreate a surveyframe model specification
sf_pathDefine a structural path between constructs
sframe_abort_branchingAbort with a branching error
sframe_abort_importAbort with an import error
sframe_abort_validationAbort with a validation error
sframe_builder_empty_stateCreate an empty SurveyStudio builder state
sframe_builder_state_from_instrumentConvert an instrument into a SurveyStudio builder state
sframe_builder_validate_draftValidate a SurveyStudio draft state
sframe_codebook_items_displayEnrich a codebook's items table for display
sframe_demo_dataLoad bundled surveyframe demo data
sframe_draw_likert_divergingDiverging stacked bar for a single Likert item (base...
sframe_draw_mosaicMosaic plot for a two-way categorical result
sframe_input_types_demo_dataLoad bundled input-types demo data
sframe_likert_scale_groupsGroup a scale's Likert items for a combined diverging chart
sframe_plot_correlation_matrixCorrelation matrix heatmap
sframe_plot_descriptivesDistribution shape by variable, standardised
sframe_plot_efa_loadingsLoadings heatmap from a fitted EFA solution
sframe_plot_efa_screeScree plot from an EFA readiness report
sframe_plot_group_comparisonGroup-comparison boxplot
sframe_plot_item_chartItem distribution chart, ggplot2 equivalent of the...
sframe_plot_likert_matrixGrouped diverging chart for a Likert matrix question
sframe_plot_likert_scaleGrouped diverging chart for a scale's Likert items
sframe_plot_missingnessMissing-data report plot: missingness rate by item
sframe_plot_paired_comparisonPaired-comparison slope plot
sframe_plot_qualityQuality report plot: straight-lining flag rate by scale
sframe_plot_regression_diagnosticsRegression diagnostic plots for a regression_linear result
sframe_plot_reliabilityReliability plot: alpha and omega by scale
sframe_plot_scale_chartScale score distribution chart, ggplot2 equivalent of the...
sframe_plot_validityValidity report plot: composite reliability and AVE by...
sframe_plot_variable_distributionRaw-variable distribution panels: histogram, boxplot, and Q-Q
sframe_warn_missingWarn about missing data
sframe_warn_qualityWarn about a data quality issue
sframe_warn_scoringWarn about a scoring issue
sf_scaleDefine a scored scale
summary.sf_branchSummarise an sf_branch object
summary.sf_checkSummarise an sf_check object
summary.sf_choicesSummarise an sf_choices object
summary.sf_itemSummarise an sf_item object
summary.sf_modelSummarise an sf_model object
summary.sframeSummarise an sframe instrument object
summary.sf_scaleSummarise an sf_scale object
surveyframe-packagesurveyframe: Survey Instrument Workflows for R
survey_module_serverShiny module server for an embedded survey
survey_module_uiShiny module UI for an embedded survey
theme_surveyframesurveyframe brand theme for ggplot2
validate_modelValidate a surveyframe model specification
validate_sframeValidate an instrument object
validity_reportValidity report for construct models
write_sframeWrite an instrument to a .sframe file
surveyframe documentation built on July 25, 2026, 1:07 a.m.