Calculate the ecdf outlier "score"

step_outliers_ecdf creates a specification of a recipe step that will calculate the outlier score using the user supplied outlier_function on a ecdf basis the combination is of multiple variables is handled by the outcome

step_outliers_ecdf(
  recipe,
  ...,
  role = NA,
  trained = FALSE,
  outlier_score = NULL,
  columns = NULL,
  name_mutate = ".outliers_ecdf",
  outcome = NULL,
  skip = TRUE,
  id = rand_id("outliers_ecdf")
)

# S3 method for step_outliers_ecdf
tidy(x, ...)

Arguments

recipe

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

...

One or more selector functions to choose which variables will be transformed. See selections() for more details. For the tidy method, these are not currently used.

role

not defined for this function

trained

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

outlier_score

a placeholder for the exit of this function don't change

columns

A character string of variable names that will be populated (eventually) by the terms argument.

name_mutate

the name of the generated column with ecdf scores

outcome

column to calculate the ecdf, the rest of the columns are used as groups

skip

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.

id

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

x

A step_outliers_ecdf object.

Value

An updated version of recipe with the new step added to the sequence of existing steps (if any), with the name on name_mutate and the scores calculated. For the tidy method, a tibble with columns index (the row indexes of the tibble) and outlier_score (the scores).

Details

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

All columns used in this step must be numeric with no missing data.

When used in modeling, users should strongly consider using the option skip = TRUE so that this operation is not conducted outside of the training set.

Examples

library(recipes)
#> Loading required package: dplyr
#> 
#> Attaching package: ‘dplyr’
#> The following objects are masked from ‘package:stats’:
#> 
#>     filter, lag
#> The following objects are masked from ‘package:base’:
#> 
#>     intersect, setdiff, setequal, union
#> 
#> Attaching package: ‘recipes’
#> The following object is masked from ‘package:stats’:
#> 
#>     step
library(tidy.outliers)
rec <-
  recipe(mpg ~ ., data = mtcars) %>%
  step_outliers_ecdf(everything()) %>%
  prep(mtcars)

bake(rec, new_data = NULL)
#> # A tibble: 32 × 12
#>      cyl  disp    hp  drat    wt  qsec    vs    am  gear  carb   mpg .outliers…¹
#>    <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl>       <dbl>
#>  1     6  160    110  3.9   2.62  16.5     0     1     4     4  21             1
#>  2     6  160    110  3.9   2.88  17.0     0     1     4     4  21             1
#>  3     4  108     93  3.85  2.32  18.6     1     1     4     1  22.8           1
#>  4     6  258    110  3.08  3.22  19.4     1     0     3     1  21.4           1
#>  5     8  360    175  3.15  3.44  17.0     0     0     3     2  18.7           1
#>  6     6  225    105  2.76  3.46  20.2     1     0     3     1  18.1           1
#>  7     8  360    245  3.21  3.57  15.8     0     0     3     4  14.3           1
#>  8     4  147.    62  3.69  3.19  20       1     0     4     2  24.4           1
#>  9     4  141.    95  3.92  3.15  22.9     1     0     4     2  22.8           1
#> 10     6  168.   123  3.92  3.44  18.3     1     0     4     4  19.2           1
#> # … with 22 more rows, and abbreviated variable name ¹​.outliers_ecdf

tidy(rec, number = 1)
#> # A tibble: 32 × 3
#>    index outlier_score id                 
#>    <int>         <dbl> <chr>              
#>  1     1             1 outliers_ecdf_mI9qe
#>  2     2             1 outliers_ecdf_mI9qe
#>  3     3             1 outliers_ecdf_mI9qe
#>  4     4             1 outliers_ecdf_mI9qe
#>  5     5             1 outliers_ecdf_mI9qe
#>  6     6             1 outliers_ecdf_mI9qe
#>  7     7             1 outliers_ecdf_mI9qe
#>  8     8             1 outliers_ecdf_mI9qe
#>  9     9             1 outliers_ecdf_mI9qe
#> 10    10             1 outliers_ecdf_mI9qe
#> # … with 22 more rows