construct_noise: Construct a list of noise objects for synthesis

In tidysynthesis: A Common API for Synthesizing Data

Construct a list of noise objects for synthesis

Description

Construct a list of noise objects for synthesis

Usage

construct_noise(
  roadmap,
  default_regression_noise = NULL,
  default_classification_noise = NULL,
  custom_noise = NULL
)

Arguments

roadmap	A roadmap object
default_regression_noise	A noise function for regression models
default_classification_noise	A noise function for classification models
custom_noise	A formatted list of noise functions

Value

A named list of noise

Examples

rm <- roadmap(
  conf_data = acs_conf_nw,
  start_data = acs_start_nw
)

noise_defaults <- construct_noise(
  roadmap = rm,
  default_regression_noise = noise(),
  default_classification_noise = noise()
)


# construct_noise() can create a sequence of noise objects using a 
# fully-default approach, a hybrid approach, or a fully-customized approach. 
# All approaches require a roadmap and noise objects. 

rm <- roadmap(
  conf_data = acs_conf_nw,
  start_data = acs_start_nw
)

noise_reg <- noise(
  add_noise = TRUE,
  mode = "regression",
  noise_fun = add_noise_gaussian
)

noise_class <- noise(
  add_noise = TRUE,
  mode = "classification",
  noise_fun = add_noise_cat_unif
)

# Fully-default approach

construct_noise(
  roadmap = rm, 
  default_regression_noise = noise_reg, 
  default_classification_noise = noise_class
)

# Hybrid approach

noise_reg2 <- noise(
  add_noise = TRUE,
  mode = "regression",
  noise_fun = add_noise_disc_gaussian 
)

construct_noise(
  roadmap = rm, 
  default_regression_noise = noise_reg,
  default_classification_noise = noise_class,
  custom_noise = list(
    list(vars = "age", noise = noise_reg2)
  )
)

# Fully-customized approach

construct_noise(
  roadmap = rm, 
  custom_noise = list(
    list(vars = c("hcovany", "empstat", "classwkr"), noise = noise_class),
    list(vars = c("age", "famsize", "transit_time", "inctot"), noise = noise_reg)
  )
)

tidysynthesis documentation built on March 17, 2026, 1:06 a.m.