set_fct.data.frame: set factor

In Harrison4192/dataCleaner: Clean Data Frames

set factor

Description

allows option to manually set the first level of the factor, for consistency with yardstick which automatically considers the first level as the "positive class" when evaluating classification.

Usage

set_fct(
  .data,
  ...,
  first_level = NULL,
  order_fct = FALSE,
  labels = NULL,
  max_levels = Inf
)

## S3 method for class 'data.frame'
set_fct(.data, ..., first_level = NULL, order_fct = FALSE, max_levels = Inf)

## Default S3 method:
set_fct(.data, ..., first_level = NULL, order_fct = FALSE, max_levels = Inf)

Arguments

.data	dataframe
...	tidyselect (default selection: all character columns)
first_level	character string to set the first level of the factor
order_fct	logical. ordered factor?
labels	chr vector of labels, length equal to factor levels
max_levels	integer. uses fct_lump_n to limit the number of categories. Only the top max_levels are preserved, and the rest being lumped into "other"

Value

tibble

Examples

## simply set the first level of a factor

iris$Species %>% levels

iris %>%
  set_fct(Species, first_level = "virginica") %>%
  dplyr::pull(Species) %>%
  levels()

Harrison4192/dataCleaner documentation built on March 20, 2024, 3:12 p.m.