Package: metasurvey.core 0.3.1

Mauro Loprete

metasurvey.core: Local Engine for Reproducible Survey Data Processing

The processing engine of the 'metasurvey' ecosystem. Provides a step-based pipeline for reproducible processing of microdata from complex surveys, building on the 'survey' package for design-based estimation. Supports rotating panels with bootstrap replicate weights and a recipe system for reproducing data transformation workflows across editions of the same study.

Authors:Mauro Loprete [aut, cre], Natalia da Silva [aut], Fabricio Machado [aut]

metasurvey.core_0.3.1.tar.gz
metasurvey.core_0.3.1.zip(r-4.7-any)metasurvey.core_0.3.1.zip(r-4.6-any)metasurvey.core_0.3.1.zip(r-4.5-any)
metasurvey.core_0.3.1.tgz(r-4.6-any)metasurvey.core_0.3.1.tgz(r-4.5-any)
metasurvey.core_0.3.1.tar.gz(r-4.7-any)metasurvey.core_0.3.1.tar.gz(r-4.6-any)
metasurvey.core_0.3.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
metasurvey.core/json (API)

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

Reviews:rOpenSci Software Review #()

Bug tracker:https://github.com/metasurveyr/metasurvey.core/issues

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

On CRAN:

Conda:

4.89 score 1 packages 93 exports 17 dependencies

Last updated from:13167e4db4. Checks:7 WARNING, 3 OK. Indexed: no.

TargetResultTimeFilesSyslog
linux-develWARNING188
pkgdown docsOK350
source / vignettesOK267
linux-releaseWARNING207
macos-releaseWARNING151
macos-oldrelWARNING158
windows-develWARNING188
windows-releaseWARNING128
windows-oldrelWARNING189
wasm-releaseOK124

Exports:add_categoryadd_recipeadd_replicateadd_weightbake_recipesbake_stepscat_designcat_design_typecertify_recipedefault_categoriesevaluate_cvextract_surveysextract_time_patternfilter_recipesfilter_workflowsfind_workflows_for_recipeget_backendget_dataget_engineget_follow_upget_implantationget_metadataget_recipeget_stepsget_workflow_backendgroup_datesharmonizehas_designhas_recipeshas_stepsis_bakedlazy_defaultlist_recipeslist_workflowsload_panel_surveyload_surveyload_survey_examplePoolSurveyprovenanceprovenance_diffprovenance_to_jsonpublish_recipepublish_workflowrank_recipesrank_workflowsread_reciperead_workflowrecipeReciperecipe_categoryrecipe_certificationrecipe_userRecipeCategoryRecipeCertificationRecipeUserRecipeWorkflowremove_categoryRotativePanelSurveysave_recipesave_workflowsearch_recipessearch_workflowsset_backendset_dataset_engineset_lazy_processingset_use_copyset_user_infoset_versionset_workflow_backendshow_enginesstep_collapsestep_computestep_filterstep_joinstep_quantilestep_recodestep_removestep_renamestep_validatesteps_to_recipeSurveysurvey_emptysurvey_to_data_framesurvey_to_data.tablesurvey_to_datatablesurvey_to_tibbleuse_copy_defaultvalidate_time_patternview_graphworkflowworkflow_from_listworkflow_table

Dependencies:clidata.tableDBIgluejsonlitelatticelifecycleMatrixminqamitoolsnumDerivR6RcppRcppArmadillorlangsurveysurvival

Compatibilidad con encuestas internacionales (ES)
Introduccion | Matriz de compatibilidad | Instalacion de paquetes complementarios | ECH -- Uruguay | EPH -- Argentina | CASEN -- Chile | PNADc -- Brasil | CPS -- Estados Unidos | ENIGH -- Mexico | DHS -- Internacional | Portabilidad de recipes | Proximos pasos

Last update: 2026-10-12
Started: 2026-07-13

Creación y Compartición de Recipes (ES)
¿Por qué Recipes? | Ciclo de Vida de una Recipe | Carga de una Encuesta | Construcción de una Recipe a partir de Steps | Documentación de Recipes | Validación | Aplicación de Recipes a una Encuesta | Categorías | Certificación | Publicación y Descubrimiento de Recipes | Publicar en el Registry Público | Exploración y Búsqueda | Explorador Interactivo | Registry Privado para Instituciones | Buenas Prácticas | Próximos Pasos

Last update: 2026-10-12
Started: 2026-07-13

Creating and Sharing Recipes
Why Recipes? | Recipe Lifecycle | Loading a Survey | Building a Recipe from Steps | Recipe Documentation | Validation | Applying Recipes to a Survey | Categories | Certification | Publishing and Discovering Recipes | Publishing to the Public Registry | Browsing and Searching | Interactive Explorer | Private Registry for Institutions | Best Practices | Next Steps

Last update: 2026-10-12
Started: 2026-07-13

Diseños de encuestas y validación (ES)
Introducción | Configuración inicial | Tipos de diseño muestral | Diseño ponderado simple | Diseño estratificado por conglomerados | Inspección del diseño | Múltiples tipos de ponderadores | Ponderadores de réplicas bootstrap | Configuración del motor y el procesamiento | Motor de datos | Ejecución de steps y procesamiento diferido | Comportamiento de copia | Estimación de varianza | Varianza basada en el diseño | Estimación por dominios | Razones | Validación del pipeline | Verificación paso a paso | Validación cruzada con el paquete survey | Visualización del pipeline | Evaluación de calidad | Validación de recipes | Lista de verificación para validación | Buenas prácticas | Próximos pasos

Last update: 2026-10-12
Started: 2026-07-13

ECH Case Study: From STATA to R
The ECH harmonization problem | STATA vs metasurvey: Side-by-side comparison | Loading real ECH microdata | Step 1: Demographic variables | Step 2: Labor force classification | Step 3: Income variables | Step 4: Geographic classification | Building the recipe | Automatic documentation | Publishing to the registry | Estimation with workflow() | Domain estimation | Quality assessment | Reproducibility: same recipe, different edition | For STATA users: quick reference | Key differences | Data and acknowledgments | Next steps

Last update: 2026-10-12
Started: 2026-07-13

Estimation Workflows
What is a Workflow? | Setup | Basic Estimation | Mean | Total | Multiple Estimates at Once | Domain Estimation | Quality Assessment | RecipeWorkflow: Publishable Estimates | Creating a RecipeWorkflow | Publishing to the Registry | Finding Workflows Associated with a Recipe | Sharing via the Remote API | Full Pipeline | Provenance: Data Lineage | Publication-Quality Tables | Next Steps

Last update: 2026-10-12
Started: 2026-07-13

Estudio de caso ECH: De STATA a R (ES)
El problema de la compatibilización de la ECH | STATA vs metasurvey: Comparación lado a lado | Carga de microdatos reales de la ECH | Paso 1: Variables demográficas | Paso 2: Clasificación de la fuerza laboral | Paso 3: Variables de ingreso | Paso 4: Clasificación geográfica | Construcción del recipe | Documentación automática | Publicación en el registry | Estimación con workflow() | Estimación por dominio | Evaluación de calidad | Reproducibilidad: mismo recipe, distinta edición | Para usuarios de STATA: referencia rápida | Diferencias clave | Datos y agradecimientos | Próximos pasos

Last update: 2026-10-12
Started: 2026-07-13

Flujos de Trabajo y Estimacion (ES)
¿Qué es un Workflow? | Configuración inicial | Estimación básica | Media | Total | Múltiples estimaciones a la vez | Estimación por dominio | Evaluación de la calidad | RecipeWorkflow: Estimaciones publicables | Creación de un RecipeWorkflow | Publicación en el registro | Búsqueda de workflows asociados a un recipe | Compartir mediante la API remota | Pipeline completo | Provenance: Linaje de datos | Tablas con calidad de publicación | Próximos pasos

Last update: 2026-10-12
Started: 2026-07-13

International Survey Compatibility
Introduction | Compatibility matrix | Installing companion packages | ECH -- Uruguay | EPH -- Argentina | CASEN -- Chile | PNADc -- Brazil | CPS -- United States | ENIGH -- Mexico | DHS -- International | Recipe portability | Next steps

Last update: 2026-10-12
Started: 2026-07-13

Survey Designs and Validation
Introduction | Initial Setup | Sampling Design Types | Simple Weighted Design | Stratified Cluster Design | Design Inspection | Multiple Weight Types | Bootstrap Replicate Weights | Engine and Processing Configuration | Data Engine | Step Execution and Lazy Processing | Copy Behavior | Variance Estimation | Design-Based Variance | Domain Estimation | Ratios | Pipeline Validation | Step-by-Step Verification | Cross-Validation with the survey Package | Pipeline Visualization | Quality Assessment | Recipe Validation | Validation Checklist | Best Practices | Next Steps

Last update: 2026-10-12
Started: 2026-07-13

Paneles Rotativos y PoolSurvey (ES)
Introducción | Creación de un RotativePanelSurvey | Acceso a los componentes del panel | Aplicación de pasos a los componentes del panel | Estimación sobre componentes del panel | Análisis de corte transversal (Implantación) | Comparación entre seguimientos | PoolSurvey: Estimación combinada | Estimación agrupada | Múltiples grupos | Extracción de encuestas desde paneles | Patrones temporales | Carga de datos de panel desde archivos | Pesos replicados bootstrap | Buenas prácticas | Próximos pasos

Last update: 2026-07-13
Started: 2026-07-13

Poverty and Inequality with convey
Introduction | Setup | Preparing the design for convey | Inequality Measures | Gini coefficient | Atkinson index | Quintile share ratio (QSR) | Generalized entropy index | Poverty Measures | At-risk-of-poverty threshold | At-risk-of-poverty rate | FGT poverty indices | Full Pipeline: Steps + Convey | Quality assessment | Publication table | Provenance | References

Last update: 2026-07-13
Started: 2026-07-13

Rotating Panels and PoolSurvey
Introduction | Creating a RotativePanelSurvey | Accessing panel components | Applying steps to panel components | Estimation on panel components | Cross-sectional analysis (Implantation) | Comparison across follow-ups | PoolSurvey: Combined estimation | Pooled estimation | Multiple groups | Extracting surveys from panels | Time patterns | Loading panel data from files | Bootstrap replicate weights | Best practices | Next steps

Last update: 2026-07-13
Started: 2026-07-13

Readme and manuals

Help Manual

Help pageTopics
Add a category to a recipeadd_category
Add a recipe to a Surveyadd_recipe
Configure replicate weights for variance estimationadd_replicate
Configure weights by periodicity for Survey objectsadd_weight
Bake recipesbake_recipes
Execute all pending stepsbake_steps
Display survey design informationcat_design
cat_design_typecat_design_type
Certify a recipecertify_recipe
Default recipe categoriesdefault_categories
Evaluate estimation with Coefficient of Variationevaluate_cv
Extract surveys by periodicity from a rotating panelextract_surveys
Extract time patternextract_time_pattern
Filter recipes by criteriafilter_recipes
Filter workflows by criteriafilter_workflows
Find workflows that use a specific recipefind_workflows_for_recipe
Get recipe backendget_backend
get_dataget_data
Get the current survey data engineget_engine
Get follow-up surveys from a rotating panelget_follow_up
Get implantation survey from a rotating panelget_implantation
get_metadataget_metadata
Get recipe from repository or APIget_recipe
get_stepsget_steps
Get workflow backendget_workflow_backend
Group datesgroup_dates
Harmonize surveys using registry recipesharmonize
Check if survey has a designhas_design
Check if survey has recipeshas_recipes
Check if survey has stepshas_steps
Check if all steps are bakedis_baked
Lazy processinglazy_default
List all recipeslist_recipes
List all workflowslist_workflows
Read panel survey files from different formats and create a RotativePanelSurvey objectload_panel_survey
Load survey from file and create Survey objectload_survey
Load survey example dataload_survey_example
Condition classes signalled by metasurvey.coremetasurvey_conditions
Options used by metasurvey.coremetasurvey.core-options
PoolSurvey ClassPoolSurvey
Print provenance informationprint.metasurvey_provenance
Print provenance diffprint.metasurvey_provenance_diff
Print method for Recipe objectsprint.Recipe
Print method for RecipeWorkflow objectsprint.RecipeWorkflow
Get provenance from a survey or workflow resultprovenance provenance.data.table provenance.default provenance.Survey
Compare two provenance objectsprovenance_diff
Export provenance to JSONprovenance_to_json
Publish Recipepublish_recipe
Publish a workflow to the active backendpublish_workflow
Rank recipes by downloadsrank_recipes
Rank workflows by downloadsrank_workflows
Read Reciperead_recipe
Read a RecipeWorkflow from a JSON fileread_workflow
Create a survey data transformation reciperecipe
Create a recipe categoryrecipe_category
Create a recipe certificationrecipe_certification
Create a recipe userrecipe_user
Recipe R6 classRecipe Recipe-class
RecipeCategoryRecipeCategory
RecipeCertificationRecipeCertification
RecipeUserRecipeUser
RecipeWorkflow R6 classRecipeWorkflow RecipeWorkflow-class
Remove a category from a reciperemove_category
RotativePanelSurvey ClassRotativePanelSurvey
Save Recipesave_recipe
Save a RecipeWorkflow to a JSON filesave_workflow
Search recipessearch_recipes
Search workflowssearch_workflows
Set recipe backendset_backend
Set data on a Surveyset_data
Configure the survey data engineset_engine
Set lazy processingset_lazy_processing
Set data copy optionset_use_copy
Set user info on a recipeset_user_info
Set version on a recipeset_version
Set workflow backendset_workflow_backend
List available survey data enginesshow_engines
Collapse survey data to one row per group (step)step_collapse
Create computation steps for survey variablesstep_compute
Filter rows from survey datastep_filter
Join external data into survey (step)step_join
Weighted quantile groups (step)step_quantile
Create recoding steps for categorical variablesstep_recode
Remove variables from survey data (step)step_remove
Rename variables in survey data (step)step_rename
Validate data during the step pipelinestep_validate
Convert a list of steps to a recipesteps_to_recipe
Survey R6 classSurvey
survey_emptysurvey_empty
survey_to_data_framesurvey_to_data_frame
Convert survey to data.tablesurvey_to_data.table survey_to_datatable
survey_to_tibblesurvey_to_tibble
Get data copy optionuse_copy_default
Validate time patternvalidate_time_pattern
View graphview_graph
Execute estimation workflow for surveysworkflow
Construct a RecipeWorkflow from a plain listworkflow_from_list
Create publication-quality table from workflow resultsworkflow_table