Man pages for tidysynthesis
A Common API for Synthesizing Data

acs_confAmerican Community Survey confidential microdata (with...
acs_conf_nwAmerican Community Survey confidential microdata (without...
acs_startAmerican Community Survey starting microdata (with weights)
acs_start_nwAmerican Community Survey starting microdata (without...
add_noise_cat_unifInject noise into a categorical random variable by mixing a...
add_noise_disc_gaussianAdd discrete normal noise with mean 0 to predicted values...
add_noise_disc_laplaceAdd discrete Laplace noise with mean 0 to predicted values...
add_noise_gaussianAdd normal noise with mean 0 to predicted values with...
add_noise_kdeAdd normal noise to predicted values with variances...
add_noise_laplaceAdd Laplace noise with mean 0 to predicted values with...
add_sequence_factorAdd to visit sequence for factor variables
add_sequence_manualAdd to visit sequence using a manual method
add_sequence_numericAdd to visit sequence for numeric variables
collapse_naCollapse data frames with _NA variables to coerce related...
constraintsCreate a constraints object
constraints_apiAdd, update, or reset a 'constraints' object within an...
construct_extractorsConstruct a list of extractors for parsnip models
construct_modelsConstruct a list of models for synthesis
construct_noiseConstruct a list of noise objects for synthesis
construct_recipesConstruct a sequence of model recipes for sequential...
construct_samplersConstruct a list of samplers for synthesis
construct_tunersConstruct a list of tuning grids for hyperparameter tuning...
convert_level_to_naConvert '"NA"' values to 'NA' for categorical variables
convert_na_to_levelConvert 'NA' values to '"NA"' for categorical variables
dot-name_to_inspectconstant mapping between component names and inspections
enforce_custom_naRedefine 'NA' value for a dataset.
enforce_naAdd missing values where values should be missing according...
enforce_schemaEnforce a 'roadmap"s 'schema' on its existing data
example_naA df with different types of missingness
expand_naAdd new variables that indicate if a value is "missing" or...
invertAn S3 method for inverting a step
invert.step_BoxCoxInvert a Box-Cox transformation
invert.step_logInvert a log transformation
invert.step_YeoJohnsonInvert a Yeo-Johnson transformation
ks_distanceKolmogorov-Smirnov distance
noiseCreate a noise object
postsynth_to_roadmapConvert a incompletely synthesized 'postsynth' into a new...
postsynth_to_synth_specConvert a incompletely synthesized 'postsynth' into a new...
presynthCreate a presynth object
print.constraintsPrint the constraints object to the console with formatting
print.noisePrint the noise object to the console with formatting
print.postsynthPrint the postsynth object to the console with formatting
print.presynthprint method for presynth objects
print.replicatesPrint the replicates object to the console with formatting
print.schemaPrint the schema object to the console with formatting
print.start_methodPrint the start_method object to the console with formatting
print.synth_specPrint the replicates object to the console with formatting
print.visit_sequencePrint method for 'visit_sequence' objects
replicatesCreate a replicates object
replicates_apiAdd, update, or reset a 'replicates' object within an...
roadmapCreate a roadmap
sample_glmSample the conditional distribution created by a generalized...
sample_lmSample the conditional distribution created by a linear model
sample_rangerSample the conditional distribution created by a ranger rf...
sample_rpartSample the conditional distribution created by a CART model
schemaGenerate a 'schema' object.
schema_apiAdd, update, or reset a 'schema' object within an existing...
start_methodCreate a 'start_method' object.
start_method_apiAdd, update, or reset a start method within an existing...
start_resampleSpecify a resampling scheme for start_data
synthesizeSynthesize a data set
synth_specCreate a 'synth_spec' object
synth_spec_extractor_apiAdd, update, or remove extractors from a 'synth_spec' object
synth_spec_is_componentInspections for 'synth_spec' components
synth_spec_model_apiAdd, update, or remove custom models from a 'synth_spec'...
synth_spec_noise_apiAdd, update, or remove noise from a 'synth_spec' object
synth_spec_recipes_apiAdd, update, or remove recipe recipes from a 'synth_spec'...
synth_spec_sampler_apiAdd, update, or remove samplers from a 'synth_spec' object
synth_spec_tuner_apiAdd, update, or remove tuners from a 'synth_spec' object
tune_synthesisGenerate syntheses from multiple 'presynth' objects.
update_presynthUpdate 'presynth' object
update_synth_specTidy API calls ————–
visit_sequenceGenerate a visit sequence.
visit_sequence_apiAdd or reset a 'visit_sequence' object within an existing...
tidysynthesis documentation built on March 17, 2026, 1:06 a.m.