A Common API for Synthesizing Data

---

Documentation for package ‘tidysynthesis’ version 0.1.2

• DESCRIPTION file.
• Package NEWS.

Help Pages

A C E I K N P R S T U V misc

-- A --

acs_conf	American Community Survey confidential microdata (with weights)
acs_conf_nw	American Community Survey confidential microdata (without weights)
acs_start	American Community Survey starting microdata (with weights)
acs_start_nw	American Community Survey starting microdata (without weights)
add_constraints	Add, update, or reset a 'constraints' object within an existing 'roadmap'.
add_custom_extractors	Add, update, or remove extractors from a 'synth_spec' object
add_custom_models	Add, update, or remove custom models from a 'synth_spec' object
add_custom_noise	Add, update, or remove noise from a 'synth_spec' object
add_custom_samplers	Add, update, or remove samplers from a 'synth_spec' object
add_custom_steps	Add, update, or remove recipe recipes from a 'synth_spec' object
add_custom_tuners	Add, update, or remove tuners from a 'synth_spec' object
add_noise_cat_unif	Inject noise into a categorical random variable by mixing a sample of uniform records into the predictions.
add_noise_disc_gaussian	Add discrete normal noise with mean 0 to predicted values with constant variance
add_noise_disc_laplace	Add discrete Laplace noise with mean 0 to predicted values with constant variance
add_noise_gaussian	Add normal noise with mean 0 to predicted values with constant variance
add_noise_kde	Add normal noise to predicted values with variances calculated for ntiles using Gaussian kernel density estimators
add_noise_laplace	Add Laplace noise with mean 0 to predicted values with constant variance
add_replicates	Add, update, or reset a 'replicates' object within an existing 'roadmap'.
add_schema	Add, update, or reset a 'schema' object within an existing 'roadmap'.
add_sequence_factor	Add to visit sequence for factor variables
add_sequence_manual	Add to visit sequence using a manual method
add_sequence_numeric	Add to visit sequence for numeric variables
add_start_method	Add, update, or reset a start method within an existing 'roadmap'.

-- C --

collapse_na	Collapse data frames with _NA variables to coerce related variables to include NA
constraints	Create a constraints object
constraints_api	Add, update, or reset a 'constraints' object within an existing 'roadmap'.
construct_extractors	Construct a list of extractors for parsnip models
construct_models	Construct a list of models for synthesis
construct_noise	Construct a list of noise objects for synthesis
construct_recipes	Construct a sequence of model recipes for sequential synthesis
construct_samplers	Construct a list of samplers for synthesis
construct_tuners	Construct a list of tuning grids for hyperparameter tuning predictive models
convert_level_to_na	Convert '"NA"' values to 'NA' for categorical variables
convert_na_to_level	Convert 'NA' values to '"NA"' for categorical variables

-- E --

enforce_custom_na	Redefine 'NA' value for a dataset.
enforce_na	Add missing values where values should be missing according to _NA variables
enforce_schema	Enforce a 'roadmap"s 'schema' on its existing data
example_na	A df with different types of missingness
expand_na	Add new variables that indicate if a value is "missing" or "not missing" for original variables that contain NA

-- I --

invert	An S3 method for inverting a step
invert.recipe	An S3 method for inverting a step
invert.step_BoxCox	Invert a Box-Cox transformation
invert.step_log	Invert a log transformation
invert.step_YeoJohnson	Invert a Yeo-Johnson transformation

-- K --

ks_distance	Kolmogorov-Smirnov distance
ks_distance.data.frame	Kolmogorov-Smirnov distance
ks_distance_vec	Kolmogorov-Smirnov distance

-- N --

noise

Create a noise object

-- P --

presynth	Create a presynth object
print.constraints	Print the constraints object to the console with formatting
print.noise	Print the noise object to the console with formatting
print.postsynth	Print the postsynth object to the console with formatting
print.presynth	print method for presynth objects
print.replicates	Print the replicates object to the console with formatting
print.schema	Print the schema object to the console with formatting
print.start_method	Print the start_method object to the console with formatting
print.synth_spec	Print the replicates object to the console with formatting
print.visit_sequence	Print method for 'visit_sequence' objects

-- R --

remove_custom_extractors	Add, update, or remove extractors from a 'synth_spec' object
remove_custom_models	Add, update, or remove custom models from a 'synth_spec' object
remove_custom_noise	Add, update, or remove samplers from a 'synth_spec' object
remove_custom_samplers	Add, update, or remove samplers from a 'synth_spec' object
remove_custom_steps	Add, update, or remove recipe recipes from a 'synth_spec' object
remove_custom_tuners	Add, update, or remove tuners from a 'synth_spec' object
remove_start_method	Add, update, or reset a start method within an existing 'roadmap'.
replicates	Create a replicates object
replicates_api	Add, update, or reset a 'replicates' object within an existing 'roadmap'.
reset_constraints	Add, update, or reset a 'constraints' object within an existing 'roadmap'.
reset_replicates	Add, update, or reset a 'replicates' object within an existing 'roadmap'.
reset_schema	Add, update, or reset a 'schema' object within an existing 'roadmap'.
reset_visit_sequence	Add or reset a 'visit_sequence' object within an existing 'roadmap'.
roadmap	Create a roadmap

-- S --

sample_glm	Sample the conditional distribution created by a generalized linear model
sample_lm	Sample the conditional distribution created by a linear model
sample_ranger	Sample the conditional distribution created by a ranger rf model
sample_rpart	Sample the conditional distribution created by a CART model
schema	Generate a 'schema' object.
schema_api	Add, update, or reset a 'schema' object within an existing 'roadmap'.
start_method	Create a 'start_method' object.
start_method_api	Add, update, or reset a start method within an existing 'roadmap'.
start_resample	Specify a resampling scheme for start_data
synthesize	Synthesize a data set
synth_spec	Create a 'synth_spec' object
synth_spec_extractor_api	Add, update, or remove extractors from a 'synth_spec' object
synth_spec_is_component	Inspections for 'synth_spec' components
synth_spec_model_api	Add, update, or remove custom models from a 'synth_spec' object
synth_spec_noise_api	Add, update, or remove noise from a 'synth_spec' object
synth_spec_recipes_api	Add, update, or remove recipe recipes from a 'synth_spec' object
synth_spec_sampler_api	Add, update, or remove samplers from a 'synth_spec' object
synth_spec_tuner_api	Add, update, or remove tuners from a 'synth_spec' object

-- T --

tune_synthesis

Generate syntheses from multiple 'presynth' objects.

-- U --

update_constraints	Add, update, or reset a 'constraints' object within an existing 'roadmap'.
update_custom_extractors	Add, update, or remove extractors from a 'synth_spec' object
update_custom_models	Add, update, or remove custom models from a 'synth_spec' object
update_custom_noise	Add, update, or remove samplers from a 'synth_spec' object
update_custom_samplers	Add, update, or remove samplers from a 'synth_spec' object
update_custom_steps	Add, update, or remove recipe recipes from a 'synth_spec' object
update_custom_tuners	Add, update, or remove tuners from a 'synth_spec' object
update_presynth	Update 'presynth' object
update_replicates	Add, update, or reset a 'replicates' object within an existing 'roadmap'.
update_schema	Add, update, or reset a 'schema' object within an existing 'roadmap'.
update_start_method	Add, update, or reset a start method within an existing 'roadmap'.
update_synth_spec	Tidy API calls ---
update_visit_sequence	Add or reset a 'visit_sequence' object within an existing 'roadmap'.

-- V --

visit_sequence	Generate a visit sequence.
visit_sequence_api	Add or reset a 'visit_sequence' object within an existing 'roadmap'.

-- misc --

.name_to_inspect

constant mapping between component names and inspections