step_upsample: Up-Sample a Data Set Based on a Factor Variable

View source: R/upsample.R

step_upsampleR Documentation

Up-Sample a Data Set Based on a Factor Variable


step_upsample() creates a specification of a recipe step that will replicate rows of a data set to make the occurrence of levels in a specific factor level equal.


  over_ratio = 1,
  ratio = deprecated(),
  role = NA,
  trained = FALSE,
  column = NULL,
  target = NA,
  skip = TRUE,
  seed =^5, 1),
  id = rand_id("upsample")



A recipe object. The step will be added to the sequence of operations for this recipe.


One or more selector functions to choose which variable is used to sample the data. See selections() for more details. The selection should result in single factor variable. For the tidy method, these are not currently used.


A numeric value for the ratio of the majority-to-minority frequencies. The default value (1) means that all other levels are sampled up to have the same frequency as the most occurring level. A value of 0.5 would mean that the minority levels will have (at most) (approximately) half as many rows than the majority level.


Deprecated argument; same as over_ratio.


Not used by this step since no new variables are created.


A logical to indicate if the quantities for preprocessing have been estimated.


A character string of the variable name that will be populated (eventually) by the ... selectors.


An integer that will be used to subsample. This should not be set by the user and will be populated by prep.


A logical. Should the step be skipped when the recipe is baked by bake()? While all operations are baked when prep() is run, some operations may not be able to be conducted on new data (e.g. processing the outcome variable(s)). Care should be taken when using skip = TRUE as it may affect the computations for subsequent operations.


An integer that will be used as the seed when upsampling.


A character string that is unique to this step to identify it.


Up-sampling is intended to be performed on the training set alone. For this reason, the default is skip = TRUE.

If there are missing values in the factor variable that is used to define the sampling, missing data are selected at random in the same way that the other factor levels are sampled. Missing values are not used to determine the amount of data in the majority level (see example below).

For any data with factor levels occurring with the same frequency as the majority level, all data will be retained.

All columns in the data are sampled and returned by juice() and bake().


An updated version of recipe with the new step added to the sequence of existing steps (if any). For the tidy method, a tibble with columns terms which is the variable used to sample.


When you tidy() this step, a tibble with columns terms (the selectors or variables selected) will be returned.

Tuning Parameters

This step has 1 tuning parameters:

  • over_ratio: Over-Sampling Ratio (type: double, default: 1)

Case weights

This step performs an unsupervised operation that can utilize case weights. To use them, see the documentation in recipes::case_weights and the examples on

See Also

Other Steps for over-sampling: step_adasyn(), step_bsmote(), step_rose(), step_smotenc(), step_smote()



hpc_data0 <- hpc_data %>%
  select(-protocol, -day)

orig <- count(hpc_data0, class, name = "orig")

up_rec <- recipe(class ~ ., data = hpc_data0) %>%
  # Bring the minority levels up to about 1000 each
  # 1000/2211 is approx 0.4523
  step_upsample(class, over_ratio = 0.4523) %>%

training <- up_rec %>%
  bake(new_data = NULL) %>%
  count(class, name = "training")

# Since `skip` defaults to TRUE, baking the step has no effect
baked <- up_rec %>%
  bake(new_data = hpc_data0) %>%
  count(class, name = "baked")

# Note that if the original data contained more rows than the
# target n (= ratio * majority_n), the data are left alone:
orig %>%
  left_join(training, by = "class") %>%
  left_join(baked, by = "class")


ggplot(circle_example, aes(x, y, color = class)) +
  geom_point() +
  labs(title = "Without upsample")

recipe(class ~ x + y, data = circle_example) %>%
  step_upsample(class) %>%
  prep() %>%
  bake(new_data = NULL) %>%
  ggplot(aes(x, y, color = class)) +
  geom_jitter(width = 0.1, height = 0.1) +
  labs(title = "With upsample (with jittering)")

themis documentation built on Aug. 15, 2023, 1:05 a.m.