Package index

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.

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

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

Report

Generate codebooks, scale appendices, and reproducible HTML reports.

codebook_report()

Generate a survey codebook from an instrument object

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

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