# Survey Instrument Workflows

## Documentation for package ‘surveyframe’ version 0.4.0

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

## Help Pages

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

## -- A --

add_model | Add a model specification to an instrument
amendment_log | Read an instrument's amendment log
amend_sframe | Record a disclosed amendment to an instrument
as.data.frame.sframe | Coerce a surveyframe object to a data frame
as.data.frame.sframe_analysis_results | Coerce a surveyframe object to a data frame
as.data.frame.sframe_assumption_report | Coerce a surveyframe object to a data frame
as.data.frame.sframe_codebook | Coerce a surveyframe object to a data frame
as.data.frame.sframe_descriptives_report | Coerce a surveyframe object to a data frame
as.data.frame.sframe_efa_report | Coerce a surveyframe object to a data frame
as.data.frame.sframe_efa_solution | Coerce a surveyframe object to a data frame
as.data.frame.sframe_item_report | Coerce a surveyframe object to a data frame
as.data.frame.sframe_missing_data_report | Coerce a surveyframe object to a data frame
as.data.frame.sframe_quality_report | Coerce a surveyframe object to a data frame
as.data.frame.sframe_reliability_report | Coerce a surveyframe object to a data frame
as.data.frame.sframe_sample_size_plan | Coerce a surveyframe object to a data frame
as.data.frame.sframe_sensitivity | Coerce a surveyframe object to a data frame
as.data.frame.sframe_validation | Report on a validation result
as.data.frame.sframe_validity_report | Coerce a surveyframe object to a data frame
as.data.frame.sf_choices | Coerce a surveyframe object to a data frame
assumption_report | Assumption-check report
as_sframe | Coerce to an instrument
as_sframe.sframe | Coerce to an instrument
as_sframe.sframe_validation | Coerce to an instrument

## -- 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
clean_text_responses | Clean open-ended text responses for analysis
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
extract_quotes | Extract representative quotes for each STM topic

## -- F --

format.sframe | Format an sframe instrument object as a string
format.sframe_validation | Report on a validation result
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
link_git_commit | Link an instrument to its current Git commit

## -- M --

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

## -- N --

ngram_frequency | N-gram frequency for open-ended text

## -- 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.sframe_validation | Report on a validation result
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_component_list | A list of instrument components
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
sensitivity_analysis | Test how far a decision ranking moves when the weights are perturbed
sframe_aggregate_judgements | Aggregate individual judgement matrices
sframe_assemble_pairwise | Assemble per-respondent comparison matrices
sframe_as_data_frame | Coerce a surveyframe object to a data frame
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_collected_weights | Criterion weights collected from respondents
sframe_decision_options | Normalise the decision options of an analysis-plan block
sframe_dematel_compute | The DEMATEL total-relation classification
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_cooccurrence | Term co-occurrence heatmap
sframe_plot_cooccurrence_network | Term co-occurrence network plot
sframe_plot_correlation_matrix | Correlation matrix heatmap
sframe_plot_decision_ranking | Ranked-score bar chart for a decision-family result
sframe_plot_dematel_influence | Prominence-relation scatter for a DEMATEL result
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_ngram_frequency | N-gram-frequency plot: horizontal bar
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_sentiment | Sentiment plot: diverging bar, or a positive/negative comparison cloud
sframe_plot_term_frequency | Term-frequency plot: horizontal bar or word cloud
sframe_plot_topics | Topic-model top-terms plot: faceted bars, one facet per topic
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
sframe_rated_matrix | Build a performance matrix from rated matrix items
sframe_subset | Subset a surveyframe report
sframe_validation | Report on a validation result
sf_accessors | Explore a surveyframe object
sf_apa | Read the reportable parts of an analysis or quality result
sf_apa.sframe_analysis_results | Read the reportable parts of an analysis or quality result
sf_apa.sframe_assumption_report | Read the reportable parts of an analysis or quality result
sf_apa.sframe_descriptives_report | Read the reportable parts of an analysis or quality result
sf_apa.sframe_missing_data_report | Read the reportable parts of an analysis or quality result
sf_apa.sframe_validity_report | Read the reportable parts of an analysis or quality result
sf_branch | Define a branching rule
sf_branches | Explore a surveyframe object
sf_branches.sframe | Explore a surveyframe object
sf_check | Define a design-time survey check
sf_checks | Explore a surveyframe object
sf_checks.sframe | Explore a surveyframe object
sf_choices | Define a reusable choice set
sf_choice_sets | Explore a surveyframe object
sf_choice_sets.sframe | Explore a surveyframe object
sf_choice_sets.sframe_codebook | Explore a surveyframe object
sf_component_list | A list of instrument components
sf_conjoint_design | Declare a choice-experiment (conjoint) design
sf_construct | Define a latent or composite construct
sf_covariance | Define a covariance between constructs
sf_flagged | Read the reportable parts of an analysis or quality result
sf_flagged.sframe_quality_report | Read the reportable parts of an analysis or quality result
sf_id | The ID and label of an instrument component
sf_id.sf_branch | The ID and label of an instrument component
sf_id.sf_check | The ID and label of an instrument component
sf_id.sf_choices | The ID and label of an instrument component
sf_id.sf_item | The ID and label of an instrument component
sf_id.sf_model | The ID and label of an instrument component
sf_id.sf_scale | The ID and label of an instrument component
sf_identity | The ID and label of an instrument component
sf_indirect | Define an indirect effect path
sf_instrument | Create a survey instrument object
sf_is_valid | Read a validation diagnostic
sf_is_valid.sframe_validation | Read a validation diagnostic
sf_item | Define a survey item
sf_items | Explore a surveyframe object
sf_items.sframe | Explore a surveyframe object
sf_items.sframe_codebook | Explore a surveyframe object
sf_label | The ID and label of an instrument component
sf_label.sf_branch | The ID and label of an instrument component
sf_label.sf_check | The ID and label of an instrument component
sf_label.sf_choices | The ID and label of an instrument component
sf_label.sf_item | The ID and label of an instrument component
sf_label.sf_model | The ID and label of an instrument component
sf_label.sf_scale | The ID and label of an instrument component
sf_meta | Explore a surveyframe object
sf_meta.sframe | Explore a surveyframe object
sf_meta.sframe_codebook | Explore a surveyframe object
sf_model | Create a surveyframe model specification
sf_models | Explore a surveyframe object
sf_models.sframe | Explore a surveyframe object
sf_models.sframe_codebook | Explore a surveyframe object
sf_object | Read a validation diagnostic
sf_object.sframe_validation | Read a validation diagnostic
sf_path | Define a structural path between constructs
sf_plan | Explore a surveyframe object
sf_plan.sframe | Explore a surveyframe object
sf_plan.sframe_codebook | Explore a surveyframe object
sf_plan<- | Set the pre-declared analysis plan
sf_plan<-.sframe | Set the pre-declared analysis plan
sf_problems | Read a validation diagnostic
sf_problems.sframe_validation | Read a validation diagnostic
sf_report_accessors | Read the reportable parts of an analysis or quality result
sf_scale | Define a scored scale
sf_scales | Explore a surveyframe object
sf_scales.sframe | Explore a surveyframe object
sf_scales.sframe_codebook | Explore a surveyframe object
sf_validation_accessors | Read a validation diagnostic
summary.sframe | Summarise an sframe instrument object
summary.sframe_validation | Report on a validation result
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 --

term_context | Keyword-in-context concordance for open-ended text
term_frequency | Term frequency for open-ended text
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

## -- misc --

[.sframe_analysis_results | Subset a surveyframe report
[.sframe_item_report | Subset a surveyframe report
[.sframe_reliability_report | Subset a surveyframe report
[.sf_component_list | A list of instrument components