Package: surveyframe 0.4.3

Mohammed Ali Sharafuddin

surveyframe: Survey Instrument Workflows

Provides a design-first survey research workflow. An instrument, an analysis plan declared before data collection, and a measurement or structural model are held together in one typed, integrity-checked object (the 'sframe'), so a study's confirmatory tests are fixed before responses arrive rather than chosen afterward. Includes 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 with branching logic, response quality checking, scale scoring, psychometric diagnostics, analysis-plan execution, model syntax generation for EFA, CFA, CB-SEM, and PLS-SEM, an interactive response dashboard, codebook generation, and reproducible HTML reporting. Also supports multi-criteria decision analysis (AHP, ANP, DEMATEL, TOPSIS, VIKOR, MOORA, SMART, WASPAS, PROMETHEE II, ELECTRE I), small-sample survey helpers, and text and open-ended response analysis (term and n-gram frequency, keyword in context, co-occurrence and co-occurrence networks, sentiment, document-feature matrices, and topic modelling via LDA or structural topic models).

Authors:Mohammed Ali Sharafuddin [aut, cre]

surveyframe_0.4.3.tar.gz
surveyframe_0.4.3.zip(r-4.7-any)surveyframe_0.4.3.zip(r-4.6-any)surveyframe_0.4.3.zip(r-4.5-any)
surveyframe_0.4.3.tgz(r-4.6-any)surveyframe_0.4.3.tgz(r-4.5-any)
surveyframe_0.4.3.tar.gz(r-4.7-any)surveyframe_0.4.3.tar.gz(r-4.6-any)
surveyframe_0.4.3.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:

4.65 score 1 stars 41 scripts 461 downloads 210 exports 6 dependencies

Last updated from:20ed3accf0. Checks:8 ERROR, 1 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develERROR463
source / vignettesERROR331
linux-releaseERROR432
macos-releaseERROR370
macos-oldrelERROR377
windows-develERROR508
windows-releaseERROR483
windows-oldrelERROR374
wasm-releaseOK171

Exports:add_modeladd_referencesamend_sframeamendment_loganalysis_syntaxas_sframeassumption_reportbootstrap_cicfa_lavaan_syntaxcfa_syntaxclean_text_responsescodebook_reportcohens_d_cicramers_v_cidescriptives_reportefa_reportefa_solutionefa_syntaxeta_sq_ciexport_google_sheetexport_responsesexport_static_surveyexport_surveyextract_quotesitem_reportlaunch_builderlaunch_builder_demolaunch_dashboardlaunch_dashboard_demolaunch_studiolaunch_studio_demolink_git_commitmissing_data_reportmodel_jsonmodel_report_templatengram_frequencyoutlier_reportposthoc_reportpreview_demopreview_surveyquality_reportread_bibtexread_responsesread_sframeread_sheet_responsesreliability_reportrender_reportrender_resultrender_resultsrender_surveyrun_analysis_planrun_surveysample_size_planscore_scalessem_lavaan_syntaxseminr_syntaxsensitivity_analysissf_apasf_branchsf_branchessf_checksf_checkssf_choice_setssf_choicessf_conjoint_designsf_constructsf_covariancesf_flaggedsf_idsf_indirectsf_instrumentsf_is_validsf_itemsf_itemssf_labelsf_metasf_missing_columnssf_modelsf_modelssf_objectsf_pathsf_plansf_plan<-sf_problemssf_referencesf_scalesf_scalessframe_add_modelsframe_add_referencessframe_aggregate_judgementssframe_analysis_qmdsframe_apasframe_apa_cellssframe_assemble_pairwisesframe_assumption_resultssframe_attention_checksframe_bibliographysframe_bootstrap_cisframe_branchsframe_choice_setsframe_clean_textsframe_codebooksframe_cohens_d_cisframe_collected_weightssframe_conjoint_designsframe_constructsframe_covariancesframe_cramers_v_cisframe_decision_optionssframe_demosframe_demo_datasframe_demo_qmdsframe_demossframe_descriptives_resultssframe_drop_itemssframe_efa_readiness_resultssframe_efa_solutionsframe_eta_sq_cisframe_export_labelledsframe_extract_quotessframe_flaggedsframe_format_resultsframe_get_amendmentssframe_get_attention_checkssframe_get_branchessframe_get_choice_setssframe_get_itemssframe_get_modelssframe_get_referencessframe_get_scalessframe_get_studysframe_idsframe_indirect_effectsframe_input_types_demo_datasframe_instrumentsframe_is_validsframe_itemsframe_item_flagssframe_item_resultssframe_labelsframe_link_git_commitsframe_list_demossframe_metasframe_missing_columnssframe_missing_data_resultssframe_model_jsonsframe_model_outlinesframe_model_specsframe_ngram_frequencysframe_notessframe_objectsframe_outlier_resultssframe_pathsframe_plansframe_plan<-sframe_plot_cooccurrencesframe_plot_cooccurrence_networksframe_plot_correlation_matrixsframe_plot_decision_rankingsframe_plot_dematel_influencesframe_plot_descriptivessframe_plot_efa_loadingssframe_plot_efa_screesframe_plot_group_comparisonsframe_plot_likert_matrixsframe_plot_likert_scalesframe_plot_missingnesssframe_plot_ngram_frequencysframe_plot_paired_comparisonsframe_plot_qualitysframe_plot_regression_diagnosticssframe_plot_reliabilitysframe_plot_sentimentsframe_plot_term_frequencysframe_plot_topicssframe_plot_validitysframe_plot_variable_distributionsframe_posthoc_resultssframe_problemssframe_quality_resultssframe_rated_matrixsframe_referencesframe_referencessframe_reliability_resultssframe_report_sourcesframe_sample_size_plansframe_sampling_methodssframe_save_figuressframe_scalesframe_sensitivity_analysissframe_survey_serversframe_survey_uisframe_syntax_cfasframe_syntax_efasframe_syntax_plssframe_syntax_resultsframe_syntax_semsframe_term_contextsframe_term_frequencysframe_validate_modelsframe_validity_resultssurvey_module_serversurvey_module_uiterm_contextterm_frequencytheme_surveyframevalidate_modelvalidate_sframevalidity_reportwrite_sframe

Dependencies:askpasscommonmarkjsonliteopensslrlangsys

Readme and manuals

Help Manual

Help pageTopics
surveyframe: Survey Instrument Workflows for Rsurveyframe-package surveyframe
Record a disclosed amendment to an instrumentamend_sframe
Coerce to an instrumentas_sframe
Coerce a choice set to a data frameas.data.frame.sf_choices
Coerce an instrument to its item summaryas.data.frame.sframe
Summarise analysis-plan results as a data frameas.data.frame.sframe_analysis_results
Coerce an assumption report to a data frameas.data.frame.sframe_assumption_report
Extract the item table from a codebook reportas.data.frame.sframe_codebook
Extract the descriptives results tableas.data.frame.sframe_descriptives_report
Coerce an EFA readiness report to a data frameas.data.frame.sframe_efa_report
Extract the loading table from an EFA solutionas.data.frame.sframe_efa_solution
Coerce an item report to a data frameas.data.frame.sframe_item_report
Extract item missingness resultsas.data.frame.sframe_missing_data_report
Coerce a response-quality report to a data frameas.data.frame.sframe_quality_report
Coerce a reliability report to a data frameas.data.frame.sframe_reliability_report
Coerce a sample-size plan to a data frameas.data.frame.sframe_sample_size_plan
Extract a sensitivity-analysis results tableas.data.frame.sframe_sensitivity
Coerce validation problems to a data frameas.data.frame.sframe_validation
Extract reliability evidence from a validity reportas.data.frame.sframe_validity_report
Export a survey instrument to Google Sheets collection formatexport_google_sheet
Write responses to SPSS or Stata with the labels attachedexport_responses
Export a self-contained static HTML surveyexport_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
Launch the surveyframe visual survey builderlaunch_builder
Launch the SurveyStudio interfacelaunch_studio
Plot analysis-plan resultsplot.sframe_analysis_results
Preview a survey as a respondent sees itpreview_survey
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
Read references from BibTeXread_bibtex
Read and validate survey responsesread_responses
Read an instrument from a .sframe fileread_sframe
Read survey responses from a Google Sheetread_sheet_responses
Render a reproducible survey reportrender_report
Render analysis results to a formatted HTML reportrender_results
Run a pre-planned analysis from an instrument's analysis planrun_analysis_plan
Render a survey from an instrument objectrun_survey
Score defined scales from survey responsesscore_scales
A list of instrument componentssf_component_list
Explore a surveyframe objectsframe_accessors sf_accessors
Add a model specification to an instrumentsframe_add_model
Add references to an instrumentsframe_add_references
Aggregate individual judgement matricessframe_aggregate_judgements
Write a Quarto analysis notebook for any instrumentsframe_analysis_qmd
Extract APA-formatted result summariessframe_apa
Coerce a surveyframe object to a data framesframe_as_data_frame
Assemble per-respondent comparison matricessframe_assemble_pairwise
Assumption-check reportsframe_assumption_results
Define a design-time survey checksframe_attention_check
Write a bibliography as CSL-JSONsframe_bibliography
Percentile bootstrap confidence interval for a statisticsframe_bootstrap_ci
Define a branching rulesframe_branch
Define a reusable choice setsframe_choice_set
Clean open-ended text responses for analysissframe_clean_text
Generate a survey codebook from an instrument objectsframe_codebook
Bootstrap confidence interval for Cohen's dsframe_cohens_d_ci
Criterion weights collected from respondentssframe_collected_weights
Declare a choice-experiment (conjoint) designsframe_conjoint_design
Define a latent or composite constructsframe_construct
Define a covariance between constructssframe_covariance
Bootstrap confidence interval for Cramer's Vsframe_cramers_v_ci
Normalise the decision options of an analysis-plan blocksframe_decision_options
The DEMATEL total-relation classificationsframe_dematel_compute
Load one bundled demosframe_demo
Copy a demo's Quarto notebook so you can run and change itsframe_demo_qmd
Descriptive statistics reportsframe_descriptives_results
Drop items from scales or modelssframe_drop_items
Prepare a survey instrument for exploratory factor analysissframe_efa_readiness_results
Estimate an exploratory factor solutionsframe_efa_solution
Bootstrap confidence interval for eta squaredsframe_eta_sq_ci
Extract representative quotes for each STM topicsframe_extract_quotes
Get rows flagged by response-quality checkssframe_flagged
Render one analysis result as the report doessframe_format_result
Read an instrument's amendment logsframe_get_amendments
Get response-quality checkssframe_get_attention_checks
Get branching rulessframe_get_branches
Get choice setssframe_get_choice_sets
Get survey itemssframe_get_items
Get model specificationssframe_get_models
List an instrument's referencessframe_get_references
Get survey scalessframe_get_scales
The study an instrument servessframe_get_study
Get an instrument component IDsframe_id
The ID and label of an instrument componentsframe_identity sf_identity
Define an indirect effect pathsframe_indirect_effect
Create a survey instrument objectsframe_instrument
Test whether validation passedsframe_is_valid
Define a survey itemsframe_item
Items past the usual cut-offs in a measurement resultsframe_item_flags
Generate item-level diagnosticssframe_item_results
Get an instrument component labelsframe_label
Link an instrument to its current Git commitsframe_link_git_commit
List the bundled demossframe_list_demos
Get survey metadatasframe_meta
Columns the instrument declares that the responses left outsframe_missing_columns
Missing-data reportsframe_missing_data_results
Serialise a model specification to JSONsframe_model_json
Create a model reporting templatesframe_model_outline
Create a surveyframe model specificationsframe_model_spec
N-gram frequency for open-ended textsframe_ngram_frequency
Notes from a validationsframe_notes
Recover the validated objectsframe_object
Flag univariate and multivariate outlierssframe_outlier_results
Define a structural path between constructssframe_path
Get the pre-declared analysis plansframe_plan
Set the pre-declared analysis plansframe_plan<-
Term co-occurrence heatmapsframe_plot_cooccurrence
Term co-occurrence network plotsframe_plot_cooccurrence_network
Correlation matrix heatmapsframe_plot_correlation_matrix
Ranked-score bar chart for a decision-family resultsframe_plot_decision_ranking
Prominence-relation scatter for a DEMATEL resultsframe_plot_dematel_influence
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
N-gram-frequency plot: horizontal barsframe_plot_ngram_frequency
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
Sentiment plot: diverging bar, or a positive/negative comparison cloudsframe_plot_sentiment
Term-frequency plot: horizontal bar or word cloudsframe_plot_term_frequency
Topic-model top-terms plot: faceted bars, one facet per topicsframe_plot_topics
Validity report plot: composite reliability and AVE by constructsframe_plot_validity
Raw-variable distribution panels: histogram, boxplot, and Q-Qsframe_plot_variable_distribution
Choosing a plotsframe_plots
Post-hoc and pairwise comparison reportsframe_posthoc_results
Get validation problemssframe_problems
Generate a data quality report for survey responsessframe_quality_results
Build a performance matrix from rated matrix itemssframe_rated_matrix
Create a referencesframe_reference
Estimate scale reliability from item responsessframe_reliability_results
Read the reportable parts of an analysis or quality resultsframe_report_accessors sf_report_accessors
Recompute and check a report source foldersframe_report_source
Choosing a reportsframe_reports
Sample-size and power planning helpersframe_sample_size_plan
Sampling methods a study can declaresframe_sampling_methods
Save the charts from an analysis plan as filessframe_save_figures
Define a scored scalesframe_scale
Test how far a decision ranking moves when the weights are perturbedsframe_sensitivity_analysis
Subset a surveyframe reportsframe_subset
Shiny module server for an embedded surveysframe_survey_server
Shiny module UI for an embedded surveysframe_survey_ui
Generate lavaan CFA syntax from an instrument or a declared modelsframe_syntax_cfa
Generate EFA planning syntaxsframe_syntax_efa
Generate seminr PLS-SEM syntaxsframe_syntax_pls
The R code behind an analysis resultsframe_syntax_result
Generate lavaan CB-SEM syntaxsframe_syntax_sem
Keyword-in-context concordance for open-ended textsframe_term_context
Term frequency for open-ended textsframe_term_frequency
Validate a surveyframe model specificationsframe_validate_model
Report on a validation resultsframe_validation
Read a validation diagnosticsframe_validation_accessors sf_validation_accessors
Validity report for construct modelssframe_validity_results
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
Superseded function namesadd_model add_references amendment_log analysis_syntax assumption_report bootstrap_ci cfa_lavaan_syntax cfa_syntax clean_text_responses codebook_report cohens_d_ci cramers_v_ci descriptives_report efa_report efa_solution efa_syntax eta_sq_ci export_static_survey extract_quotes item_report launch_builder_demo launch_dashboard launch_dashboard_demo launch_studio_demo link_git_commit missing_data_report model_json model_report_template ngram_frequency outlier_report posthoc_report preview_demo quality_report reliability_report render_result render_survey sample_size_plan seminr_syntax sem_lavaan_syntax sensitivity_analysis sframe_demos sframe_demo_data sframe_export_labelled sframe_input_types_demo_data sframe_references sf_apa sf_branch sf_branches sf_check sf_checks sf_choices sf_choice_sets sf_conjoint_design sf_construct sf_covariance sf_flagged sf_id sf_indirect sf_instrument sf_is_valid sf_item sf_items sf_label sf_meta sf_missing_columns sf_model sf_models sf_object sf_path sf_plan sf_plan<- sf_problems sf_reference sf_scale sf_scales superseded survey_module_server survey_module_ui term_context term_frequency validate_model validity_report
surveyframe brand theme for ggplot2theme_surveyframe
Validate an instrument objectvalidate_sframe
Write an instrument to a .sframe filewrite_sframe