R/surveyframe-package.R

In surveyframe: Survey Instrument Workflows

#' surveyframe: Survey Instrument Workflows for R
#'
#' @description
#' 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, and model syntax planning for EFA, CFA, CB-SEM, and
#' PLS-SEM.
#'
#' ## Core workflow
#'
#' 1. **Design** an instrument with [launch_builder()] or [sf_instrument()] and
#'    its component constructors: [sf_item()], [sf_choices()], [sf_scale()],
#'    [sf_branch()], [sf_check()].
#' 2. **Validate and save** with [validate_sframe()] and [write_sframe()].
#' 3. **Deploy** a Shiny survey with [render_survey()].
#' 4. **Load responses** with [read_responses()] or [read_sheet_responses()].
#' 5. **Check quality** with [quality_report()].
#' 6. **Score and analyse** with [score_scales()], [descriptives_report()],
#'    [missing_data_report()], [reliability_report()], [item_report()],
#'    [efa_report()], [cfa_syntax()], and [run_analysis_plan()].
#' 7. **Report** with [codebook_report()], [render_report()], and
#'    [render_results()].
#'
#' ## The instrument object
#'
#' Every function in the package operates on an `sframe` object. The object
#' is the single source of truth for item definitions, scale structure,
#' reverse-coding keys, branching rules, check specifications, analysis plans,
#' and optional model specifications.
#'
#' ## 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.
#'
#' @keywords internal
"_PACKAGE"

## usethis namespace: start
#' @importFrom jsonlite toJSON fromJSON
#' @importFrom rlang abort warn arg_match check_installed %||%
#' @importFrom openssl sha256
#' @importFrom stats cor sd var complete.cases density
#' @importFrom utils capture.output
## usethis namespace: end
NULL