% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/surveyframe-package.R
\docType{package}
\name{surveyframe-package}
\alias{surveyframe}
\alias{surveyframe-package}
\title{surveyframe: Survey Instrument Workflows for R}
\description{
surveyframe defines a survey instrument as a first-class R object and
supports a workflow from instrument design through data collection,
quality checking, scoring, psychometric diagnostics, and reproducible
reporting. Version 0.3 adds static HTML survey export, an embeddable Shiny
survey module, an interactive response dashboard, a role-based analysis
planner, common survey statistics, and model syntax planning for EFA, CFA,
CB-SEM, and PLS-SEM.
\subsection{Core workflow}{
\enumerate{
\item \strong{Design} an instrument with \code{\link[=launch_builder]{launch_builder()}} or \code{\link[=sf_instrument]{sf_instrument()}} and
its component constructors: \code{\link[=sf_item]{sf_item()}}, \code{\link[=sf_choices]{sf_choices()}}, \code{\link[=sf_scale]{sf_scale()}},
\code{\link[=sf_branch]{sf_branch()}}, \code{\link[=sf_check]{sf_check()}}.
\item \strong{Validate and save} with \code{\link[=validate_sframe]{validate_sframe()}} and \code{\link[=write_sframe]{write_sframe()}}.
\item \strong{Deploy} a Shiny survey with \code{\link[=render_survey]{render_survey()}}.
\item \strong{Load responses} with \code{\link[=read_responses]{read_responses()}} or \code{\link[=read_sheet_responses]{read_sheet_responses()}}.
\item \strong{Check quality} with \code{\link[=quality_report]{quality_report()}}.
\item \strong{Score and analyse} with \code{\link[=score_scales]{score_scales()}}, \code{\link[=descriptives_report]{descriptives_report()}},
\code{\link[=missing_data_report]{missing_data_report()}}, \code{\link[=reliability_report]{reliability_report()}}, \code{\link[=item_report]{item_report()}},
\code{\link[=efa_report]{efa_report()}}, \code{\link[=cfa_syntax]{cfa_syntax()}}, and \code{\link[=run_analysis_plan]{run_analysis_plan()}}.
\item \strong{Report} with \code{\link[=codebook_report]{codebook_report()}}, \code{\link[=render_report]{render_report()}}, and
\code{\link[=render_results]{render_results()}}.
}
}

\subsection{The instrument object}{

Every function in the package operates on an \code{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.
}

\subsection{File format}{

Instruments are stored as UTF-8 JSON files with the \code{.sframe} extension.
Each file includes a SHA-256 integrity hash for reproducibility auditing.
}
}
\seealso{
Useful links:
\itemize{
  \item \url{https://github.com/MohammedAliSharafuddin/surveyframe}
  \item Report bugs at \url{https://github.com/MohammedAliSharafuddin/surveyframe/issues}
}

}
\author{
\strong{Maintainer}: Mohammed Ali Sharafuddin \email{mohammedali.page@gmail.com} (\href{https://orcid.org/0000-0001-5247-2964}{ORCID})

Authors:
\itemize{
  \item Mohammed Ali Sharafuddin \email{mohammedali.page@gmail.com} (\href{https://orcid.org/0000-0001-5247-2964}{ORCID})
}

}
\keyword{internal}
