Skip to contents

Surveys

Create and manipulate Survey objects

Survey
Survey R6 class
RotativePanelSurvey
RotativePanelSurvey Class
PoolSurvey
PoolSurvey Class
load_survey()
Load survey from file and create Survey object
load_panel_survey()
Read panel survey files from different formats and create a RotativePanelSurvey object
load_survey_example()
Load survey example data
survey_empty()
survey_empty
get_data()
get_data
set_data()
Set data on a Survey
get_metadata()
get_metadata
get_steps()
get_steps
has_steps()
Check if survey has steps
has_recipes()
Check if survey has recipes
has_design()
Check if survey has a design
is_baked()
Check if all steps are baked
survey_to_data_frame()
survey_to_data_frame
survey_to_datatable() survey_to_data.table()
Convert survey to data.table
survey_to_tibble()
survey_to_tibble

Steps

Lazy transformations on surveys

step_compute()
Create computation steps for survey variables
step_recode()
Create recoding steps for categorical variables
step_filter()
Filter rows from survey data
step_rename()
Rename variables in survey data (step)
step_remove()
Remove variables from survey data (step)
step_join()
Join external data into survey (step)
step_validate()
Validate data during the step pipeline
bake_steps()
Execute all pending steps

Recipes

Reproducible and portable pipelines

Recipe-class Recipe
Recipe R6 class
recipe()
Create a survey data transformation recipe
steps_to_recipe()
Convert a list of steps to a recipe
add_recipe()
Add a recipe to a Survey
bake_recipes()
Bake recipes
save_recipe()
Save Recipe
read_recipe()
Read Recipe
get_recipe()
Get recipe from repository or API
certify_recipe()
Certify a recipe
print(<Recipe>)
Print method for Recipe objects
recipe_user()
Create a recipe user
recipe_category()
Create a recipe category
recipe_certification()
Create a recipe certification
add_category()
Add a category to a recipe
remove_category()
Remove a category from a recipe
default_categories()
Default recipe categories
set_user_info()
Set user info on a recipe
set_version()
Set version on a recipe

Recipe Discovery

Search, filter, and publish recipes

list_recipes()
List all recipes
search_recipes()
Search recipes
filter_recipes()
Filter recipes by criteria
rank_recipes()
Rank recipes by downloads
explore_recipes()
Launch the Recipe Explorer Shiny App
publish_recipe()
Publish Recipe
set_backend()
Set recipe backend
get_backend()
Get recipe backend

Estimation

Survey estimation workflows

workflow()
Execute estimation workflow for surveys
workflow_table()
Create publication-quality table from workflow results
RecipeWorkflow-class RecipeWorkflow
RecipeWorkflow R6 class
evaluate_cv()
Evaluate estimation with Coefficient of Variation

Provenance

Data lineage and audit trails

provenance()
Get provenance from a survey or workflow result
provenance_to_json()
Export provenance to JSON
provenance_diff()
Compare two provenance objects
print(<metasurvey_provenance>)
Print provenance information
print(<metasurvey_provenance_diff>)
Print provenance diff
save_workflow()
Save a RecipeWorkflow to a JSON file
read_workflow()
Read a RecipeWorkflow from a JSON file
workflow_from_list()
Construct a RecipeWorkflow from a plain list
list_workflows()
List all workflows
search_workflows()
Search workflows
filter_workflows()
Filter workflows by criteria
rank_workflows()
Rank workflows by downloads
find_workflows_for_recipe()
Find workflows that use a specific recipe
publish_workflow()
Publish a workflow to the active backend
set_workflow_backend()
Set workflow backend
get_workflow_backend()
Get workflow backend
reproduce_workflow()
Reproduce a workflow from its published specification
print(<RecipeWorkflow>)
Print method for RecipeWorkflow objects

Rotating Panels

Panels with implantation and follow-ups

get_implantation()
Get implantation survey from a rotating panel
get_follow_up()
Get follow-up surveys from a rotating panel
extract_surveys()
Extract surveys by periodicity from a rotating panel

Weights and Design

Weight and sampling design configuration

add_weight()
Configure weights by periodicity for Survey objects
add_replicate()
Configure replicate weights for variance estimation
resolve_weight_spec()
Resolve a portable weight specification to a usable weight configuration
cat_design()
Display survey design information
cat_design_type()
cat_design_type
set_engine()
Configure the survey data engine
get_engine()
Get the current survey data engine
show_engines()
List available survey data engines
set_use_copy()
Set data copy option
use_copy_default()
Get data copy option
set_lazy_processing()
Set lazy processing
lazy_default()
Lazy processing

Time and Dates

Utilities for editions and periodicity

extract_time_pattern()
Extract time pattern
validate_time_pattern()
Validate time pattern
group_dates()
Group dates

Visualization

view_graph()
View graph

Remote API

REST client for the recipe registry

configure_api()
Configure metasurvey API
api_login()
Login
api_logout()
Logout
api_register()
Register a new user
api_me()
Get current user profile
api_refresh_token()
Refresh JWT token
api_list_recipes()
List recipes from API
api_get_recipe()
Get recipe(s) by ID
api_publish_recipe()
Publish a recipe
api_list_workflows()
List workflows from API
api_get_workflow()
Get a single workflow by ID
api_publish_workflow()
Publish a workflow
api_get_anda_variables()
Get ANDA variable metadata from the API
api_star_recipe()
Rate a recipe
api_get_recipe_stars()
Get star summary for a recipe
api_comment_recipe()
Add a comment to a recipe
api_get_recipe_comments()
Get comments for a recipe
api_get_recipe_dependents()
Get recipes that depend on a recipe
api_star_workflow()
Rate a workflow
api_get_workflow_stars()
Get star summary for a workflow
api_comment_workflow()
Add a comment to a workflow
api_get_workflow_comments()
Get comments for a workflow
api_delete_comment()
Delete a comment

ANDA

INE Uruguay ANDA catalog metadata

anda_variables() experimental
Query ANDA variable metadata from the API
anda_download_microdata() experimental
Download ECH microdata from ANDA5

STATA Transpiler

Convert STATA do-files to metasurvey recipes

transpile_stata() experimental
Transpile a STATA .do file to metasurvey steps
transpile_stata_module() experimental
Transpile and group do-files by thematic module
transpile_coverage() experimental
Analyze transpilation coverage for STATA do-files
parse_do_file()
Parse a STATA .do file into structured commands
parse_stata_labels()
Parse STATA label commands from source lines

Ecosystem Classes

R6 classes for the recipe ecosystem

RecipeCategory
RecipeCategory
RecipeCertification
RecipeCertification
RecipeUser
RecipeUser