Package index • surveyframe

Design

Start visually in the HTML SurveyBuilder or construct instruments in R.

launch_builder(): Launch the surveyframe visual survey builder
launch_builder_demo(): Launch SurveyBuilder with the bundled input-types demo preloaded
launch_studio_demo(): Launch SurveyStudio with the bundled input-types demo
launch_dashboard_demo(): Launch the response dashboard with the bundled input-types demo

Build an instrument

Constructor functions for building the sframe instrument object. Start here.

sf_instrument(): Create a survey instrument object
sf_item(): Define a survey item
sf_choices(): Define a reusable choice set
sf_scale(): Define a scored scale
sf_branch(): Define a branching rule
sf_check(): Define a design-time survey check
sf_model(): Create a surveyframe model specification
sf_construct(): Define a latent or composite construct
sf_path(): Define a structural path between constructs
sf_covariance(): Define a covariance between constructs
sf_indirect(): Define an indirect effect path
add_model(): Add a model specification to an instrument

Save and load

Read and write instruments as portable .sframe JSON files with SHA-256 integrity hashing, and record disclosed revisions to them.

write_sframe(): Write an instrument to a .sframe file
read_sframe(): Read an instrument from a .sframe file
validate_sframe(): Validate an instrument object
validate_model(): Validate a surveyframe model specification
model_json(): Serialise a model specification to JSON
amend_sframe(): Record a disclosed amendment to an instrument
amendment_log(): Read an instrument's amendment log
link_git_commit(): Link an instrument to its current Git commit
print(<sframe_validation>) format(<sframe_validation>) summary(<sframe_validation>) as.data.frame(<sframe_validation>): Report on a validation result

Accessors and coercion

Read parts of an instrument, a validation result, or a report without reaching into the object directly, new in 0.4.0.

as_sframe(): Coerce to an instrument
sf_meta() sf_items() sf_scales() sf_choice_sets() sf_branches() sf_checks() sf_models() sf_plan(): Explore a surveyframe object
print(<sf_component_list>) `[`(<sf_component_list>): A list of instrument components
sf_id() sf_label(): The ID and label of an instrument component
`sf_plan<-`(): Set the pre-declared analysis plan
sf_apa() sf_flagged(): Read the reportable parts of an analysis or quality result
sf_is_valid() sf_problems() sf_object(): Read a validation diagnostic
as.data.frame(<sframe>) as.data.frame(<sf_choices>) as.data.frame(<sframe_codebook>) as.data.frame(<sframe_reliability_report>) as.data.frame(<sframe_item_report>) as.data.frame(<sframe_efa_report>) as.data.frame(<sframe_efa_solution>) as.data.frame(<sframe_descriptives_report>) as.data.frame(<sframe_missing_data_report>) as.data.frame(<sframe_validity_report>) as.data.frame(<sframe_assumption_report>) as.data.frame(<sframe_sample_size_plan>) as.data.frame(<sframe_quality_report>) as.data.frame(<sframe_sensitivity>) as.data.frame(<sframe_analysis_results>): Coerce a surveyframe object to a data frame
`[`(<sframe_analysis_results>) `[`(<sframe_reliability_report>) `[`(<sframe_item_report>): Subset a surveyframe report

Deploy

Render the instrument as a Shiny survey or launch SurveyStudio.

render_survey(): Render a survey from an instrument object
export_static_survey(): Export a self-contained static HTML survey
launch_studio(): Launch the SurveyStudio interface
launch_dashboard(): Launch the interactive response dashboard
survey_module_ui(): Shiny module UI for an embedded survey
survey_module_server(): Shiny module server for an embedded survey

Collect responses

Load and validate response data against the instrument specification.

read_responses(): Read and validate survey responses
export_google_sheet(): Export a survey instrument to Google Sheets collection format
read_sheet_responses(): Read survey responses from a Google Sheet

Quality checks

Evaluate response data for attention check failures, straight-lining, missingness, and duplicate submissions.

quality_report(): Generate a data quality report for survey responses
missing_data_report(): Missing-data report
outlier_report(): Flag univariate and multivariate outliers
assumption_report(): Assumption-check report

Score and analyse

Score composite scales, compute reliability statistics, and prepare psychometric diagnostics and pre-planned analyses.

score_scales(): Score defined scales from survey responses
descriptives_report(): Descriptive statistics report
reliability_report(): Compute reliability statistics for scored scales
item_report(): Generate item-level diagnostics
efa_report(): Prepare a survey instrument for exploratory factor analysis
efa_solution(): Estimate an exploratory factor solution
validity_report(): Validity report for construct models
cfa_syntax(): Generate lavaan CFA syntax from an instrument object
cfa_lavaan_syntax(): Generate lavaan CFA syntax
efa_syntax(): Generate EFA planning syntax
sem_lavaan_syntax(): Generate lavaan CB-SEM syntax
seminr_syntax(): Generate seminr PLS-SEM syntax
posthoc_report(): Post-hoc and pairwise comparison report
sample_size_plan(): Sample-size and power planning helper
run_analysis_plan(): Run a pre-planned analysis from an instrument's analysis plan

Decision analysis

Multi-criteria decision analysis, new in 0.4.0. The 10 methods run through the analysis plan like any other, so the functions here are the ones that assemble their input, test how stable a ranking is, and build choice designs.

sensitivity_analysis(): Test how far a decision ranking moves when the weights are perturbed
sf_conjoint_design(): Declare a choice-experiment (conjoint) design
sframe_assemble_pairwise(): Assemble per-respondent comparison matrices
sframe_aggregate_judgements(): Aggregate individual judgement matrices
sframe_collected_weights(): Criterion weights collected from respondents
sframe_rated_matrix(): Build a performance matrix from rated matrix items
sframe_decision_options(): Normalise the decision options of an analysis-plan block
sframe_dematel_compute(): The DEMATEL total-relation classification

Text analysis

Structured analysis of open-ended text responses, new in 0.5.0: term and n-gram frequency, keyword-in-context concordance, co-occurrence (plain and network), sentiment, topic modelling, and quote extraction.

clean_text_responses(): Clean open-ended text responses for analysis
term_frequency(): Term frequency for open-ended text
ngram_frequency(): N-gram frequency for open-ended text
term_context(): Keyword-in-context concordance for open-ended text
extract_quotes(): Extract representative quotes for each STM topic

Confidence intervals

Base-R bootstrap and effect-size confidence interval helpers, reused across the inferential runners.

bootstrap_ci(): Percentile bootstrap confidence interval for a statistic
cohens_d_ci(): Bootstrap confidence interval for Cohen's d
cramers_v_ci(): Bootstrap confidence interval for Cramer's V
eta_sq_ci(): Bootstrap confidence interval for eta squared

Report

Generate codebooks, scale appendices, and reproducible HTML reports.

codebook_report(): Generate a survey codebook from an instrument object
sframe_codebook_items_display(): Enrich a codebook's items table for display
render_report(): Render a reproducible survey report
render_results(): Render analysis results to a formatted HTML report
model_report_template(): Create a model reporting template

Plotting

Opt-in ggplot2 charts for analysis results, and the package theme.

theme_surveyframe(): surveyframe brand theme for ggplot2
plot(<sframe_analysis_results>): Plot analysis-plan results
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_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
sframe_draw_mosaic(): Mosaic plot for a two-way categorical result
sframe_likert_scale_groups(): Group a scale's Likert items for a combined diverging chart
sframe_plot_term_frequency(): Term-frequency plot: horizontal bar or word cloud
sframe_plot_ngram_frequency(): N-gram-frequency plot: horizontal bar
sframe_plot_cooccurrence(): Term co-occurrence heatmap
sframe_plot_cooccurrence_network(): Term co-occurrence network plot
sframe_plot_sentiment(): Sentiment plot: diverging bar, or a positive/negative comparison cloud
sframe_plot_topics(): Topic-model top-terms plot: faceted bars, one facet per topic

Print, format, and summary methods

S3 methods so every component object prints and summarises cleanly at the console and inside reports.

print(<sframe>): Print an sframe instrument object
format(<sframe>): Format an sframe instrument object as a string
summary(<sframe>): Summarise an sframe instrument object
print(<sf_choices>): Print an sf_choices object
format(<sf_choices>): Format an sf_choices object as a string
summary(<sf_choices>): Summarise an sf_choices object
print(<sf_item>): Print an sf_item object
format(<sf_item>): Format an sf_item object as a string
summary(<sf_item>): Summarise an sf_item object
print(<sf_scale>): Print an sf_scale object
format(<sf_scale>): Format an sf_scale object as a string
summary(<sf_scale>): Summarise an sf_scale object
print(<sf_branch>): Print an sf_branch object
format(<sf_branch>): Format an sf_branch object as a string
summary(<sf_branch>): Summarise an sf_branch object
print(<sf_check>): Print an sf_check object
format(<sf_check>): Format an sf_check object as a string
summary(<sf_check>): Summarise an sf_check object
print(<sf_model>): Print an sf_model object
format(<sf_model>): Format an sf_model object as a string
summary(<sf_model>): Summarise an sf_model object

Package

surveyframe surveyframe-package: surveyframe: Survey Instrument Workflows for R
sframe_demo_data(): Load bundled surveyframe demo data
sframe_input_types_demo_data(): Load bundled input-types demo data
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