noise: Create a noise object

In tidysynthesis: A Common API for Synthesizing Data

Create a noise object

Description

Create a noise object

Usage

noise(add_noise = FALSE, mode = "regression", noise_func = NULL, ...)

Arguments

add_noise	Boolean, TRUE if adding noise
mode	String, one of "regression" or "classification"
noise_func	A function that adds noise to
...	Optional named additional arguments to pass to noise_func(...)

Value

A noise object

Examples

# create default noise object
noise()

# create noise object for classification
noise(
  add_noise = TRUE,
  mode = "classification",
  noise_func = add_noise_cat_unif
)

# create noise object for regression
noise(
  add_noise = TRUE,
  mode = "regression",
  noise_func = add_noise_kde,
  n_ntiles = 10
)

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