Package: surveyframe 0.3.4

Mohammed Ali Sharafuddin

surveyframe: Survey Instrument Workflows

Supports survey research workflows built around a typed instrument object (the sframe). Features include visual instrument design via a browser-based builder or 'Shiny' studio, export to a self-contained static HTML survey, an embeddable 'Shiny' module, SHA-256 integrity-checked serialisation to the '.sframe' format, multi-page survey rendering, branching logic, response quality checking, scale scoring, psychometric diagnostics, analysis-plan execution, model syntax planning, an interactive response dashboard, codebook generation, and reproducible HTML reporting.

Authors:Mohammed Ali Sharafuddin [aut, cre]

surveyframe_0.3.4.tar.gz
surveyframe_0.3.4.zip(r-4.7-any)surveyframe_0.3.4.zip(r-4.6-any)surveyframe_0.3.4.zip(r-4.5-any)
surveyframe_0.3.4.tgz(r-4.6-any)surveyframe_0.3.4.tgz(r-4.5-any)
surveyframe_0.3.4.tar.gz(r-4.7-any)surveyframe_0.3.4.tar.gz(r-4.6-any)
surveyframe_0.3.4.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
surveyframe/json (API)

# Install 'surveyframe' in R:
install.packages('surveyframe', repos = c('https://mohammedalisharafuddin.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/mohammedalisharafuddin/surveyframe/issues

Pkgdown/docs site:https://mohammedalisharafuddin.github.io

On CRAN:

Conda:

5.79 score 1 stars 16 scripts 320 downloads 83 exports 5 dependencies

Last updated from:6556f91d87. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK356
source / vignettesOK303
linux-release-x86_64OK356
macos-release-arm64OK243
macos-oldrel-arm64OK176
windows-devel-x86_64OK329
windows-release-x86_64OK310
windows-oldrel-x86_64OK316
wasm-releaseOK132

Exports:add_modelassumption_reportbootstrap_cicfa_lavaan_syntaxcfa_syntaxcodebook_reportcohens_d_cicramers_v_cidescriptives_reportefa_reportefa_solutionefa_syntaxeta_sq_ciexport_google_sheetexport_static_surveyitem_reportlaunch_builderlaunch_builder_demolaunch_dashboardlaunch_dashboard_demolaunch_studiolaunch_studio_demomissing_data_reportmodel_jsonmodel_report_templateoutlier_reportposthoc_reportquality_reportread_responsesread_sframeread_sheet_responsesreliability_reportrender_reportrender_resultsrender_surveyrun_analysis_plansample_size_planscore_scalessem_lavaan_syntaxseminr_syntaxsf_branchsf_checksf_choicessf_constructsf_covariancesf_indirectsf_instrumentsf_itemsf_modelsf_pathsf_scalesframe_builder_empty_statesframe_builder_state_from_instrumentsframe_builder_validate_draftsframe_codebook_items_displaysframe_demo_datasframe_draw_likert_divergingsframe_draw_mosaicsframe_input_types_demo_datasframe_likert_scale_groupssframe_plot_correlation_matrixsframe_plot_descriptivessframe_plot_efa_loadingssframe_plot_efa_screesframe_plot_group_comparisonsframe_plot_item_chartsframe_plot_likert_matrixsframe_plot_likert_scalesframe_plot_missingnesssframe_plot_paired_comparisonsframe_plot_qualitysframe_plot_regression_diagnosticssframe_plot_reliabilitysframe_plot_scale_chartsframe_plot_validitysframe_plot_variable_distributionsurvey_module_serversurvey_module_uitheme_surveyframevalidate_modelvalidate_sframevalidity_reportwrite_sframe

Dependencies:askpassjsonliteopensslrlangsys

Analysing survey responses: running the plan
Load the demo | Import responses | Missing data and quality | Score scales | Check assumptions before the plan | Define the plan | Run the plan | Read a single result | Render the results report | In SurveyStudio
Rendered fromanalysing-survey-responses.Rmdusingknitr::rmarkdown

Last update: 2026-07-16
Started: 2026-05-14

Building a survey instrument: questions, plan, and model
Choice sets | Items and item types | Scales, reverse coding, and minimum valid items | Attention checks | Branching | The analysis plan | Assemble the instrument | Validate the instrument | Write and read .sframe files | GUI option
Rendered frombuilding-survey-instrument.Rmdusingknitr::rmarkdown

Last update: 2026-07-16
Started: 2026-05-14

Deploying a survey and collecting responses on free hosting
What you need | Step 1: Create the Google Sheet and the collector | Step 2: Deploy the collector as a web app | Step 3: Put the endpoint into the survey | Step 4a: Host on GitHub Pages | Step 4b: Host on Blogger | Step 5: Read the responses back | Updating a live survey | Checklist
Rendered fromdeploying-and-collecting.Rmdusingknitr::rmarkdown

Last update: 2026-07-16
Started: 2026-06-14

EFA, CFA, CB-SEM, and PLS-SEM syntax generation
EFA planning syntax | CFA syntax: the lower-order measurement model | CB-SEM syntax: the structural model | PLS-SEM syntax: the two-stage higher-order model | Construct modes | Model JSON and a reporting template | Where the syntax goes next
Rendered fromefa-cfa-sem-pls-syntax.Rmdusingknitr::rmarkdown

Last update: 2026-07-16
Started: 2026-05-14

Scale reliability and validity
Reliability from the instrument | Item diagnostics | EFA readiness | Convergent validity from the published loadings | Discriminant validity | Collinearity | Cautious interpretation
Rendered fromscale-reliability-validity.Rmdusingknitr::rmarkdown

Last update: 2026-07-16
Started: 2026-05-14

Survey design and live results: a tourism services example
About this vignette | The questionnaire | Shared Likert scale | Helper functions | Digital marketing items | Destination service quality items | Destination sustainability quality (DSUQ, 11 items) | Tourist satisfaction (TS, 3 items) and behavioural intention (BI, 3 items) | Demographic items | Scales | Assemble the instrument | Validate and serialise | Set up data collection | Store the Google Sheets endpoint in the instrument | Export the static HTML survey | What the respondent sees | Generate the Google Sheets collector script | Pull live responses | Simulated responses for offline demonstration | Quality checks | Score and describe | Reliability | EFA readiness | Construct validity | Analysis plan | Assumption checks | Run the analysis plan | Plots on demand | Results report | The live workflow | Summary
Rendered fromsurveyframe.Rmdusingknitr::rmarkdown

Last update: 2026-07-16
Started: 2026-04-16

The visual workflow: SurveyBuilder, SurveyStudio, and the dashboard
Input-types demo | SurveyBuilder: the Analyse mode | SurveyStudio: the screens | Recommended workflow | Demo launchers | Standalone builder | Studio workflow hub | Dashboard | Known limitations | Moving files between tools
Rendered fromsurveybuilder-gui-overview.Rmdusingknitr::rmarkdown

Last update: 2026-07-16
Started: 2026-05-14

Readme and manuals

Help Manual

Help pageTopics
Add a model specification to an instrumentadd_model
Assumption-check reportassumption_report
Percentile bootstrap confidence interval for a statisticbootstrap_ci
Generate lavaan CFA syntaxcfa_lavaan_syntax
Generate lavaan CFA syntax from an instrument objectcfa_syntax
Generate a survey codebook from an instrument objectcodebook_report
Bootstrap confidence interval for Cohen's dcohens_d_ci
Bootstrap confidence interval for Cramer's Vcramers_v_ci
Descriptive statistics reportdescriptives_report
Prepare a survey instrument for exploratory factor analysisefa_report
Estimate an exploratory factor solutionefa_solution
Generate EFA planning syntaxefa_syntax
Bootstrap confidence interval for eta squaredeta_sq_ci
Export a survey instrument to Google Sheets collection formatexport_google_sheet
Export a self-contained static HTML surveyexport_static_survey
Format an sf_branch object as a stringformat.sf_branch
Format an sf_check object as a stringformat.sf_check
Format an sf_choices object as a stringformat.sf_choices
Format an sf_item object as a stringformat.sf_item
Format an sf_model object as a stringformat.sf_model
Format an sf_scale object as a stringformat.sf_scale
Format an sframe instrument object as a stringformat.sframe
Generate item-level diagnosticsitem_report
Launch the surveyframe visual survey builderlaunch_builder
Launch SurveyBuilder with the bundled input-types demo preloadedlaunch_builder_demo
Launch the interactive response dashboardlaunch_dashboard
Launch the response dashboard with the bundled input-types demolaunch_dashboard_demo
Launch the SurveyStudio interfacelaunch_studio
Launch SurveyStudio with the bundled input-types demolaunch_studio_demo
Missing-data reportmissing_data_report
Serialise a model specification to JSONmodel_json
Create a model reporting templatemodel_report_template
Flag univariate and multivariate outliersoutlier_report
Plot analysis-plan resultsplot.sframe_analysis_results
Post-hoc and pairwise comparison reportposthoc_report
Print an sf_branch objectprint.sf_branch
Print an sf_check objectprint.sf_check
Print an sf_choices objectprint.sf_choices
Print an sf_item objectprint.sf_item
Print an sf_model objectprint.sf_model
Print an sf_scale objectprint.sf_scale
Print an sframe instrument objectprint.sframe
Generate a data quality report for survey responsesquality_report
Read and validate survey responsesread_responses
Read an instrument from a .sframe fileread_sframe
Read survey responses from a Google Sheetread_sheet_responses
Compute reliability statistics for scored scalesreliability_report
Render a reproducible survey reportrender_report
Render analysis results to a formatted HTML reportrender_results
Render a survey from an instrument objectrender_survey
Run a pre-planned analysis from an instrument's analysis planrun_analysis_plan
Sample-size and power planning helpersample_size_plan
Score defined scales from survey responsesscore_scales
Generate lavaan CB-SEM syntaxsem_lavaan_syntax
Generate seminr PLS-SEM syntaxseminr_syntax
Define a branching rulesf_branch
Define a design-time survey checksf_check
Define a reusable choice setsf_choices
Define a latent or composite constructsf_construct
Define a covariance between constructssf_covariance
Define an indirect effect pathsf_indirect
Create a survey instrument objectsf_instrument
Define a survey itemsf_item
Create a surveyframe model specificationsf_model
Define a structural path between constructssf_path
Define a scored scalesf_scale
Create an empty SurveyStudio builder statesframe_builder_empty_state
Convert an instrument into a SurveyStudio builder statesframe_builder_state_from_instrument
Validate a SurveyStudio draft statesframe_builder_validate_draft
Enrich a codebook's items table for displaysframe_codebook_items_display
Load bundled surveyframe demo datasframe_demo_data
Mosaic plot for a two-way categorical resultsframe_draw_mosaic
Load bundled input-types demo datasframe_input_types_demo_data
Group a scale's Likert items for a combined diverging chartsframe_likert_scale_groups
Correlation matrix heatmapsframe_plot_correlation_matrix
Distribution shape by variable, standardisedsframe_plot_descriptives
Loadings heatmap from a fitted EFA solutionsframe_plot_efa_loadings
Scree plot from an EFA readiness reportsframe_plot_efa_scree
Group-comparison boxplotsframe_plot_group_comparison
Grouped diverging chart for a Likert matrix questionsframe_plot_likert_matrix
Grouped diverging chart for a scale's Likert itemssframe_plot_likert_scale
Missing-data report plot: missingness rate by itemsframe_plot_missingness
Paired-comparison slope plotsframe_plot_paired_comparison
Quality report plot: straight-lining flag rate by scalesframe_plot_quality
Regression diagnostic plots for a regression_linear resultsframe_plot_regression_diagnostics
Reliability plot: alpha and omega by scalesframe_plot_reliability
Validity report plot: composite reliability and AVE by constructsframe_plot_validity
Raw-variable distribution panels: histogram, boxplot, and Q-Qsframe_plot_variable_distribution
Summarise an sf_branch objectsummary.sf_branch
Summarise an sf_check objectsummary.sf_check
Summarise an sf_choices objectsummary.sf_choices
Summarise an sf_item objectsummary.sf_item
Summarise an sf_model objectsummary.sf_model
Summarise an sf_scale objectsummary.sf_scale
Summarise an sframe instrument objectsummary.sframe
Shiny module server for an embedded surveysurvey_module_server
Shiny module UI for an embedded surveysurvey_module_ui
surveyframe brand theme for ggplot2theme_surveyframe
Validate a surveyframe model specificationvalidate_model
Validate an instrument objectvalidate_sframe
Validity report for construct modelsvalidity_report
Write an instrument to a .sframe filewrite_sframe