Reproducible Survey Data Processing with Step Pipelines

Documentation for package ‘metasurvey’ version 0.0.21

Help Pages

-- A --

add_category	Add a category to a recipe
add_recipe	Add a recipe to a Survey
add_replicate	Configure replicate weights for variance estimation
add_weight	Configure weights by periodicity for Survey objects
anda_download_microdata	Download ECH microdata from ANDA5
anda_variables	Query ANDA variable metadata from the API
api_comment_recipe	Add a comment to a recipe
api_comment_workflow	Add a comment to a workflow
api_delete_comment	Delete a comment
api_get_anda_variables	Get ANDA variable metadata from the API
api_get_recipe	Get recipe(s) by ID
api_get_recipe_comments	Get comments for a recipe
api_get_recipe_dependents	Get recipes that depend on a recipe
api_get_recipe_stars	Get star summary for a recipe
api_get_workflow	Get a single workflow by ID
api_get_workflow_comments	Get comments for a workflow
api_get_workflow_stars	Get star summary for a workflow
api_list_recipes	List recipes from API
api_list_workflows	List workflows from API
api_login	Login
api_logout	Logout
api_me	Get current user profile
api_publish_recipe	Publish a recipe
api_publish_workflow	Publish a workflow
api_refresh_token	Refresh JWT token
api_register	Register a new user
api_star_recipe	Rate a recipe
api_star_workflow	Rate a workflow

-- B --

bake_recipes	Bake recipes
bake_steps	Execute all pending steps

-- C --

cat_design	Display survey design information
cat_design_type	cat_design_type
certify_recipe	Certify a recipe
configure_api	Configure metasurvey API

-- D --

Default recipe categories

-- E --

evaluate_cv	Evaluate estimation with Coefficient of Variation
explore_recipes	Launch the Recipe Explorer Shiny App
extract_surveys	Extract surveys by periodicity from a rotating panel
extract_time_pattern	Extract time pattern

-- F --

filter_recipes	Filter recipes by criteria
filter_workflows	Filter workflows by criteria
find_workflows_for_recipe	Find workflows that use a specific recipe

-- G --

get_backend	Get recipe backend
get_data	get_data
get_engine	Get the current survey data engine
get_follow_up	Get follow-up surveys from a rotating panel
get_implantation	Get implantation survey from a rotating panel
get_metadata	get_metadata
get_recipe	Get recipe from repository or API
get_steps	get_steps
get_workflow_backend	Get workflow backend
group_dates	Group dates

-- H --

-- I --

Check if all steps are baked

-- L --

lazy_default	Lazy processing
list_recipes	List all recipes
list_workflows	List all workflows
load_panel_survey	Read panel survey files from different formats and create a RotativePanelSurvey object
load_survey	Load survey from file and create Survey object
load_survey_example	Load survey example data

-- P --

parse_do_file	Parse a STATA .do file into structured commands
parse_stata_labels	Parse STATA label commands from source lines
PoolSurvey	PoolSurvey Class
print.metasurvey_provenance	Print provenance information
print.metasurvey_provenance_diff	Print provenance diff
print.Recipe	Print method for Recipe objects
print.RecipeWorkflow	Print method for RecipeWorkflow objects
provenance	Get provenance from a survey or workflow result
provenance.data.table	Get provenance from a survey or workflow result
provenance.default	Get provenance from a survey or workflow result
provenance.Survey	Get provenance from a survey or workflow result
provenance_diff	Compare two provenance objects
provenance_to_json	Export provenance to JSON
publish_recipe	Publish Recipe
publish_workflow	Publish a workflow to the active backend

-- R --

rank_recipes	Rank recipes by downloads
rank_workflows	Rank workflows by downloads
read_recipe	Read Recipe
read_workflow	Read a RecipeWorkflow from a JSON file
Recipe	Recipe R6 class
recipe	Create a survey data transformation recipe
Recipe-class	Recipe R6 class
RecipeCategory	RecipeCategory
RecipeCertification	RecipeCertification
RecipeUser	RecipeUser
RecipeWorkflow	RecipeWorkflow R6 class
RecipeWorkflow-class	RecipeWorkflow R6 class
recipe_category	Create a recipe category
recipe_certification	Create a recipe certification
recipe_user	Create a recipe user
remove_category	Remove a category from a recipe
reproduce_workflow	Reproduce a workflow from its published specification
resolve_weight_spec	Resolve a portable weight specification to a usable weight configuration
RotativePanelSurvey	RotativePanelSurvey Class

-- S --

save_recipe	Save Recipe
save_workflow	Save a RecipeWorkflow to a JSON file
search_recipes	Search recipes
search_workflows	Search workflows
set_backend	Set recipe backend
set_data	Set data on a Survey
set_engine	Configure the survey data engine
set_lazy_processing	Set lazy processing
set_user_info	Set user info on a recipe
set_use_copy	Set data copy option
set_version	Set version on a recipe
set_workflow_backend	Set workflow backend
show_engines	List available survey data engines
steps_to_recipe	Convert a list of steps to a recipe
step_compute	Create computation steps for survey variables
step_filter	Filter rows from survey data
step_join	Join external data into survey (step)
step_recode	Create recoding steps for categorical variables
step_remove	Remove variables from survey data (step)
step_rename	Rename variables in survey data (step)
step_validate	Validate data during the step pipeline
Survey	Survey R6 class
survey_empty	survey_empty
survey_to_data.table	Convert survey to data.table
survey_to_datatable	Convert survey to data.table
survey_to_data_frame	survey_to_data_frame
survey_to_tibble	survey_to_tibble

-- T --

transpile_coverage	Analyze transpilation coverage for STATA do-files
transpile_stata	Transpile a STATA .do file to metasurvey steps
transpile_stata_module	Transpile and group do-files by thematic module

-- U --

Get data copy option

-- V --

validate_time_pattern	Validate time pattern
view_graph	View graph

-- W --

workflow	Execute estimation workflow for surveys
workflow_from_list	Construct a RecipeWorkflow from a plain list
workflow_table	Create publication-quality table from workflow results