# Survey Instrument Workflows

## Documentation for package ‘surveyframe’ version 0.3.4

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A B C D E F I L M O P Q R S T V W

## -- A --

add_model | Add a model specification to an instrument
assumption_report | Assumption-check report

## -- B --

bootstrap_ci | Percentile bootstrap confidence interval for a statistic

## -- C --

cfa_lavaan_syntax | Generate lavaan CFA syntax
cfa_syntax | Generate lavaan CFA syntax from an instrument object
codebook_report | Generate a survey codebook from an instrument object
cohens_d_ci | Bootstrap confidence interval for Cohen's d
cramers_v_ci | Bootstrap confidence interval for Cramer's V

## -- D --

descriptives_report | Descriptive statistics report

## -- E --

efa_report | Prepare a survey instrument for exploratory factor analysis
efa_solution | Estimate an exploratory factor solution
efa_syntax | Generate EFA planning syntax
eta_sq_ci | Bootstrap confidence interval for eta squared
export_google_sheet | Export a survey instrument to Google Sheets collection format
export_static_survey | Export a self-contained static HTML survey

## -- F --

format.sframe | Format an sframe instrument object as a string
format.sf_branch | Format an sf_branch object as a string
format.sf_check | Format an sf_check object as a string
format.sf_choices | Format an sf_choices object as a string
format.sf_item | Format an sf_item object as a string
format.sf_model | Format an sf_model object as a string
format.sf_scale | Format an sf_scale object as a string

## -- I --

item_report | Generate item-level diagnostics

## -- L --

launch_builder | Launch the surveyframe visual survey builder
launch_builder_demo | Launch SurveyBuilder with the bundled input-types demo preloaded
launch_dashboard | Launch the interactive response dashboard
launch_dashboard_demo | Launch the response dashboard with the bundled input-types demo
launch_studio | Launch the SurveyStudio interface
launch_studio_demo | Launch SurveyStudio with the bundled input-types demo

## -- M --

missing_data_report | Missing-data report
model_json | Serialise a model specification to JSON
model_report_template | Create a model reporting template

## -- O --

outlier_report | Flag univariate and multivariate outliers

## -- P --

plot.sframe_analysis_results | Plot analysis-plan results
posthoc_report | Post-hoc and pairwise comparison report
print.sframe | Print an sframe instrument object
print.sf_branch | Print an sf_branch object
print.sf_check | Print an sf_check object
print.sf_choices | Print an sf_choices object
print.sf_item | Print an sf_item object
print.sf_model | Print an sf_model object
print.sf_scale | Print an sf_scale object

## -- Q --

quality_report | Generate a data quality report for survey responses

## -- R --

read_responses | Read and validate survey responses
read_sframe | Read an instrument from a .sframe file
read_sheet_responses | Read survey responses from a Google Sheet
reliability_report | Compute reliability statistics for scored scales
render_report | Render a reproducible survey report
render_results | Render analysis results to a formatted HTML report
render_survey | Render a survey from an instrument object
run_analysis_plan | Run a pre-planned analysis from an instrument's analysis plan

## -- S --

sample_size_plan | Sample-size and power planning helper
score_scales | Score defined scales from survey responses
seminr_syntax | Generate seminr PLS-SEM syntax
sem_lavaan_syntax | Generate lavaan CB-SEM syntax
sframe_builder_empty_state | Create an empty SurveyStudio builder state
sframe_builder_state_from_instrument | Convert an instrument into a SurveyStudio builder state
sframe_builder_validate_draft | Validate a SurveyStudio draft state
sframe_codebook_items_display | Enrich a codebook's items table for display
sframe_demo_data | Load bundled surveyframe demo data
sframe_draw_mosaic | Mosaic plot for a two-way categorical result
sframe_input_types_demo_data | Load bundled input-types demo data
sframe_likert_scale_groups | Group a scale's Likert items for a combined diverging chart
sframe_plot_correlation_matrix | Correlation matrix heatmap
sframe_plot_descriptives | Distribution shape by variable, standardised
sframe_plot_efa_loadings | Loadings heatmap from a fitted EFA solution
sframe_plot_efa_scree | Scree plot from an EFA readiness report
sframe_plot_group_comparison | Group-comparison boxplot
sframe_plot_likert_matrix | Grouped diverging chart for a Likert matrix question
sframe_plot_likert_scale | Grouped diverging chart for a scale's Likert items
sframe_plot_missingness | Missing-data report plot: missingness rate by item
sframe_plot_paired_comparison | Paired-comparison slope plot
sframe_plot_quality | Quality report plot: straight-lining flag rate by scale
sframe_plot_regression_diagnostics | Regression diagnostic plots for a regression_linear result
sframe_plot_reliability | Reliability plot: alpha and omega by scale
sframe_plot_validity | Validity report plot: composite reliability and AVE by construct
sframe_plot_variable_distribution | Raw-variable distribution panels: histogram, boxplot, and Q-Q
sf_branch | Define a branching rule
sf_check | Define a design-time survey check
sf_choices | Define a reusable choice set
sf_construct | Define a latent or composite construct
sf_covariance | Define a covariance between constructs
sf_indirect | Define an indirect effect path
sf_instrument | Create a survey instrument object
sf_item | Define a survey item
sf_model | Create a surveyframe model specification
sf_path | Define a structural path between constructs
sf_scale | Define a scored scale
summary.sframe | Summarise an sframe instrument object
summary.sf_branch | Summarise an sf_branch object
summary.sf_check | Summarise an sf_check object
summary.sf_choices | Summarise an sf_choices object
summary.sf_item | Summarise an sf_item object
summary.sf_model | Summarise an sf_model object
summary.sf_scale | Summarise an sf_scale object
survey_module_server | Shiny module server for an embedded survey
survey_module_ui | Shiny module UI for an embedded survey

## -- T --

theme_surveyframe | surveyframe brand theme for ggplot2

## -- V --

validate_model | Validate a surveyframe model specification
validate_sframe | Validate an instrument object
validity_report | Validity report for construct models

## -- W --

write_sframe | Write an instrument to a .sframe file