Skip to contents

surveyframe defines a survey instrument as a first-class R object and supports a complete workflow from questionnaire design through data collection, quality checking, scoring, psychometric diagnostics, and reproducible reporting. The package covers static HTML survey export, an embeddable Shiny survey module, an interactive response dashboard, a role-based analysis planner with pre-declared research questions, common survey statistics with small-sample alternatives (Hodges-Lehmann, pseudomedian, exact odds-ratio, and Firth logistic regression), multi- criteria decision analysis (AHP, ANP, DEMATEL, VIKOR, MOORA, SMART, WASPAS, PROMETHEE, ELECTRE, and TOPSIS), and model syntax planning for EFA, CFA, CB-SEM, and PLS-SEM.

Start here

launch_studio() opens SurveyStudio, where you point and click an instrument through every stage below. launch_studio(demo = "first_survey") opens it on a whole survey to try. In code, sframe_demo("first_survey") loads the same survey, and sframe_list_demos() lists 25 teaching demos, each one instrument, its responses and the results surveyframe produced. vignette("learn-by-example") teaches from the same library.

The stages follow, in order. Each names where it lives in SurveyStudio or SurveyBuilder and the function that does it in code.

Design

In SurveyBuilder, launch_builder(), the Build mode. In code, sframe_instrument() and its makers: sframe_item(), sframe_choice_set(), sframe_scale(), sframe_branch() and sframe_attention_check(). validate_sframe() checks the instrument and write_sframe() saves it as a .sframe file. validate_sframe() returns an sframe_validation diagnostic, and as_sframe() recovers the validated instrument.

Plan

In SurveyBuilder, the Plan mode. In code, sframe_plan(x) <- plan, read back with sframe_plan(). sframe_sample_size_plan() says how many responses the plan needs.

Preview

In SurveyStudio, the Preview screen. In code, preview_survey(), which collects nothing, or run_survey() for a local Shiny survey.

Collect

In SurveyBuilder, Export survey. In code, export_survey() writes a standalone page, optionally saving answers to a Google Sheet through export_google_sheet(). sframe_survey_ui() and sframe_survey_server() put the survey inside your own Shiny app.

Responses

In SurveyStudio, the Responses and Quality screens. In code, read_responses() or read_sheet_responses(), then sframe_quality_results(). export_responses() writes them with labels for SPSS or Stata.

Analyse

In SurveyStudio, the Explore, Reliability and Analyse screens. In code, score_scales() and run_analysis_plan(), which runs every block of the plan, decision-analysis blocks included. The _results functions, such as sframe_reliability_results(), run one analysis on its own.

Report

In SurveyStudio, the Report screen. In code, render_report(), render_results() and sframe_codebook().

References

In SurveyStudio, the References screen. In code, sframe_reference() and sframe_add_references(). The report lists each work once, at the end.

Amendments

In SurveyStudio, the Amendments screen. In code, amend_sframe(), read back with sframe_get_amendments().

The instrument object

The workflow runs on an sframe object. It is the single source of truth for item definitions, scale structure, reverse-coding keys, branching rules, check specifications, analysis plans, and optional model specifications. Accessors such as sframe_meta(), sframe_get_items(), sframe_get_scales(), sframe_plan(), and sframe_get_models() read its parts without reaching into the object directly.

Some helpers work on plain vectors, for use beside that workflow or on their own: the text helpers such as sframe_term_frequency(), and the interval helpers sframe_bootstrap_ci(), sframe_cohens_d_ci(), sframe_cramers_v_ci() and sframe_eta_sq_ci().

How functions are named

Names come in 2 kinds, so a function says which stage it belongs to.

Lister names use the sframe_get_ prefix, such as sframe_get_items(). The names used before 0.4.3 still work, silently. See superseded.

File format

Instruments are stored as UTF-8 JSON files with the .sframe extension. Each file includes a SHA-256 integrity hash for reproducibility auditing.

Author

Maintainer: Mohammed Ali Sharafuddin mohammedali.page@gmail.com (ORCID)

Authors: