From dd4df836dd870f9c50b8a5040ac28a931af92230 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Mon, 2 Oct 2023 09:47:32 -0700 Subject: [PATCH 01/12] improve documentation for tidy methods --- R/BoxCox.R | 11 ++++++++--- R/YeoJohnson.R | 11 ++++++++--- R/arrange.R | 13 ++++++++----- R/bin2factor.R | 11 ++++++++--- R/bs.R | 11 ++++++++--- R/center.R | 13 +++++++++---- R/classdist.R | 12 +++++++++--- R/classdist_shrunken.R | 19 ++++++++++++++----- R/corr.R | 9 +++++++-- R/count.R | 11 ++++++++--- R/cut.R | 11 +++++++++++ R/date.R | 12 ++++++++++++ R/depth.R | 12 +++++++++--- R/discretize.R | 11 ++++++++--- R/dummy.R | 11 ++++++++--- R/dummy_extract.R | 14 +++++++++----- R/dummy_multi_choice.R | 11 +++++++++++ R/factor2string.R | 9 +++++++-- R/filter.R | 12 ++++++++---- R/filter_missing.R | 9 +++++++-- R/geodist.R | 16 +++++++++++++--- R/harmonic.R | 14 ++++++++++++++ R/holiday.R | 12 +++++++++--- R/hyperbolic.R | 12 +++++++++--- R/ica.R | 12 +++++++++--- R/impute_bag.R | 11 +++++++++++ R/impute_knn.R | 12 +++++++++--- R/impute_linear.R | 13 +++++++++---- R/impute_lower.R | 13 +++++++++---- R/impute_mean.R | 11 ++++++++--- R/impute_median.R | 11 ++++++++--- R/impute_mode.R | 11 ++++++++--- R/impute_roll.R | 13 +++++++++---- R/indicate_na.R | 10 +++++++--- R/integer.R | 11 ++++++++--- R/interact.R | 9 +++++++-- R/intercept.R | 10 ++++++++-- R/inverse.R | 9 +++++++-- R/invlogit.R | 11 ++++++++--- R/isomap.R | 9 +++++++-- R/kpca.R | 12 ++++++++++++ R/kpca_poly.R | 10 ++++++++++ R/kpca_rbf.R | 10 ++++++++++ R/lag.R | 9 +++++++-- R/lincomb.R | 11 ++++++++--- R/log.R | 10 ++++++++-- R/logit.R | 11 ++++++++--- R/mutate.R | 13 +++++++++---- R/mutate_at.R | 9 +++++++-- R/naomit.R | 12 ++++++++++++ R/nnmf.R | 12 +++++++++--- R/nnmf_sparse.R | 14 ++++++++++---- R/normalize.R | 15 ++++++++++----- R/novel.R | 11 ++++++++--- R/ns.R | 11 ++++++++--- R/num2factor.R | 10 ++++++++-- R/nzv.R | 9 +++++++-- R/ordinalscore.R | 11 ++++++++--- R/other.R | 11 ++++++++--- R/pca.R | 24 +++++++++++++++++++++--- R/percentile.R | 14 ++++++++++++++ R/pls.R | 18 ++++++++---------- R/poly.R | 10 ++++++++-- R/poly_bernstein.R | 9 +++++++-- R/profile.R | 13 +++++++++---- R/range.R | 14 ++++++++++---- R/ratio.R | 11 +++++++++++ R/regex.R | 11 ++++++++--- R/relevel.R | 17 +++++++++++++++-- R/relu.R | 30 ++++++++++++++++++++++-------- R/rename.R | 11 ++++++++--- R/rename_at.R | 9 +++++++-- R/rm.R | 9 +++++++-- R/sample.R | 11 +++++++++-- R/scale.R | 13 +++++++++---- R/select.R | 10 +++++++--- R/shuffle.R | 9 +++++++-- R/slice.R | 11 ++++++++--- R/spatialsign.R | 9 +++++++-- R/spline_b.R | 9 +++++++-- R/spline_convex.R | 9 +++++++-- R/spline_monotone.R | 9 +++++++-- R/spline_natural.R | 9 +++++++-- R/spline_nonnegative.R | 9 +++++++-- R/sqrt.R | 9 +++++++-- R/string2factor.R | 13 +++++++++---- R/time.R | 13 +++++++++---- R/unknown.R | 11 ++++++++--- R/unorder.R | 9 +++++++-- R/window.R | 12 +++++++++--- R/zv.R | 9 +++++++-- man/step_BoxCox.Rd | 11 ++++++++--- man/step_YeoJohnson.Rd | 11 ++++++++--- man/step_arrange.Rd | 11 +++++++---- man/step_bin2factor.Rd | 9 +++++++-- man/step_bs.Rd | 9 +++++++-- man/step_center.Rd | 11 ++++++++--- man/step_classdist.Rd | 12 +++++++++--- man/step_classdist_shrunken.Rd | 19 ++++++++++++++----- man/step_corr.Rd | 9 +++++++-- man/step_count.Rd | 11 ++++++++--- man/step_cut.Rd | 11 +++++++++++ man/step_date.Rd | 10 ++++++++++ man/step_depth.Rd | 10 ++++++++-- man/step_discretize.Rd | 11 ++++++++--- man/step_dummy.Rd | 11 ++++++++--- man/step_dummy_extract.Rd | 12 ++++++++---- man/step_dummy_multi_choice.Rd | 11 +++++++++++ man/step_factor2string.Rd | 9 +++++++-- man/step_filter.Rd | 10 +++++++--- man/step_filter_missing.Rd | 9 +++++++-- man/step_geodist.Rd | 16 +++++++++++++--- man/step_harmonic.Rd | 14 ++++++++++++++ man/step_holiday.Rd | 10 ++++++++-- man/step_hyperbolic.Rd | 12 +++++++++--- man/step_ica.Rd | 12 +++++++++--- man/step_impute_bag.Rd | 9 +++++++++ man/step_impute_knn.Rd | 12 +++++++++--- man/step_impute_linear.Rd | 11 ++++++++--- man/step_impute_lower.Rd | 15 ++++++++++----- man/step_impute_mean.Rd | 11 ++++++++--- man/step_impute_median.Rd | 11 ++++++++--- man/step_impute_mode.Rd | 11 ++++++++--- man/step_impute_roll.Rd | 11 ++++++++--- man/step_indicate_na.Rd | 10 +++++++--- man/step_integer.Rd | 11 ++++++++--- man/step_interact.Rd | 9 +++++++-- man/step_intercept.Rd | 9 +++++++-- man/step_inverse.Rd | 9 +++++++-- man/step_invlogit.Rd | 9 +++++++-- man/step_isomap.Rd | 9 +++++++-- man/step_kpca.Rd | 10 ++++++++++ man/step_kpca_poly.Rd | 10 ++++++++++ man/step_kpca_rbf.Rd | 10 ++++++++++ man/step_lag.Rd | 9 +++++++-- man/step_lincomb.Rd | 9 +++++++-- man/step_log.Rd | 10 ++++++++-- man/step_logit.Rd | 9 +++++++-- man/step_mutate.Rd | 11 ++++++++--- man/step_mutate_at.Rd | 9 +++++++-- man/step_naomit.Rd | 10 ++++++++++ man/step_nnmf.Rd | 12 +++++++++--- man/step_nnmf_sparse.Rd | 12 +++++++++--- man/step_normalize.Rd | 13 +++++++++---- man/step_novel.Rd | 11 ++++++++--- man/step_ns.Rd | 9 +++++++-- man/step_num2factor.Rd | 10 ++++++++-- man/step_nzv.Rd | 9 +++++++-- man/step_ordinalscore.Rd | 9 +++++++-- man/step_other.Rd | 11 ++++++++--- man/step_pca.Rd | 24 +++++++++++++++++++++--- man/step_percentile.Rd | 12 ++++++++++++ man/step_pls.Rd | 20 +++++++++----------- man/step_poly.Rd | 10 ++++++++-- man/step_poly_bernstein.Rd | 9 +++++++-- man/step_profile.Rd | 11 ++++++++--- man/step_range.Rd | 12 +++++++++--- man/step_ratio.Rd | 9 +++++++++ man/step_regex.Rd | 11 ++++++++--- man/step_relevel.Rd | 11 +++++++++++ man/step_relu.Rd | 16 +++++++++++++--- man/step_rename.Rd | 11 ++++++++--- man/step_rename_at.Rd | 9 +++++++-- man/step_rm.Rd | 9 +++++++-- man/step_sample.Rd | 11 +++++++++-- man/step_scale.Rd | 15 ++++++++++----- man/step_select.Rd | 10 +++++++--- man/step_shuffle.Rd | 9 +++++++-- man/step_slice.Rd | 9 +++++++-- man/step_spatialsign.Rd | 9 +++++++-- man/step_spline_b.Rd | 9 +++++++-- man/step_spline_convex.Rd | 9 +++++++-- man/step_spline_monotone.Rd | 9 +++++++-- man/step_spline_natural.Rd | 9 +++++++-- man/step_spline_nonnegative.Rd | 9 +++++++-- man/step_sqrt.Rd | 9 +++++++-- man/step_string2factor.Rd | 11 ++++++++--- man/step_time.Rd | 11 ++++++++--- man/step_unknown.Rd | 11 ++++++++--- man/step_unorder.Rd | 9 +++++++-- man/step_window.Rd | 12 +++++++++--- man/step_zv.Rd | 9 +++++++-- 182 files changed, 1582 insertions(+), 461 deletions(-) diff --git a/R/BoxCox.R b/R/BoxCox.R index bed3800e3..fcd024e88 100644 --- a/R/BoxCox.R +++ b/R/BoxCox.R @@ -33,9 +33,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `value` (the -#' lambda estimate) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{numeric, the lambda estimate} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/YeoJohnson.R b/R/YeoJohnson.R index 891ad18e7..9e129fab5 100644 --- a/R/YeoJohnson.R +++ b/R/YeoJohnson.R @@ -32,9 +32,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `value` (the -#' lambda estimate) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{numeric, the lambda estimate} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/arrange.R b/R/arrange.R index d6b71a879..07b9bdb0f 100644 --- a/R/arrange.R +++ b/R/arrange.R @@ -15,12 +15,15 @@ #' to embed the value of the object in the expression (to #' be portable between sessions). See the examples. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` which contains the sorting variable(s) or expression(s) is -#' returned. The expressions are text representations and are not -#' parsable. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/bin2factor.R b/R/bin2factor.R index 2498cb8ae..9abfbd445 100644 --- a/R/bin2factor.R +++ b/R/bin2factor.R @@ -19,10 +19,15 @@ #' density of numeric binary data. Note that the numeric data is #' only verified to be numeric (and does not count levels). #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/bs.R b/R/bs.R index 880c1133c..5b4bab2e3 100644 --- a/R/bs.R +++ b/R/bs.R @@ -25,10 +25,15 @@ #' from the data and new columns are added. The naming convention #' for the new variables is `varname_bs_1` and so on. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_bs" diff --git a/R/center.R b/R/center.R index a69b7106e..6669991af 100644 --- a/R/center.R +++ b/R/center.R @@ -32,11 +32,16 @@ #' argument of `prep.recipe`. `bake.recipe` then applies #' the centering to new data sets using these means. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `value` (the means) -#' is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{character, the means} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-unsupervised #' diff --git a/R/classdist.R b/R/classdist.R index a5fd96096..bb3f24976 100644 --- a/R/classdist.R +++ b/R/classdist.R @@ -42,9 +42,15 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected), `value` (the centroid -#' of the class), and `class` is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `value`, `class` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{numeric, location of centroid} +#' \item{class}{character, name of the class} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-supervised #' diff --git a/R/classdist_shrunken.R b/R/classdist_shrunken.R index c0b6e1b35..52ab709a6 100644 --- a/R/classdist_shrunken.R +++ b/R/classdist_shrunken.R @@ -40,11 +40,20 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected), `value` (the centroid), -#' `class`, and `type` is returned. Type has values `"global"`, `"by_class"`, -#' and `"shrunken"`. The first two types of centroids are in the original units -#' while the last have been standardized. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 6 +#' columns `terms`, `value`, `class`, `type`, `threshold` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{numeric, the centroid} +#' \item{class}{character, name of class variable} +#' \item{type}{character, has values global, by_class, and shrunken} +#' \item{threshold}{numeric, value of threshold} +#' \item{id}{character, id of this step} +#' } +#' +#' The first two types of centroids are in the original units while the last +#' have been standardized. #' #' @template case-weights-supervised #' @references diff --git a/R/corr.R b/R/corr.R index d9d78403e..f844231d2 100644 --- a/R/corr.R +++ b/R/corr.R @@ -39,8 +39,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be removed) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_corr" diff --git a/R/count.R b/R/count.R index b68fd4b42..e1c41f97e 100644 --- a/R/count.R +++ b/R/count.R @@ -26,9 +26,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `result` (the -#' new column name) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `result` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{result}{character, the new column names} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/cut.R b/R/cut.R index 6dbd10636..052b4893c 100644 --- a/R/cut.R +++ b/R/cut.R @@ -19,6 +19,17 @@ #' `step_cut()` will call `base::cut()` in the baking step with #' `include.lowest` set to `TRUE`. #' +#' # Tidying +#' +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{character, the location of the cuts} +#' \item{id}{character, id of this step} +#' } +#' #' @template case-weights-not-supported #' #' @examples diff --git a/R/date.R b/R/date.R index 1ea39e5bc..ec04fd636 100644 --- a/R/date.R +++ b/R/date.R @@ -48,6 +48,18 @@ #' `terms` (the selectors or variables selected), `value` (the feature #' names), and `ordinal` (a logical) is returned. #' +#' # Tidying +#' +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `value`, `ordinal` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{character, the feature names} +#' \item{ordinal}{logical, are factors ordered} +#' \item{id}{character, id of this step} +#' } +#' #' @template case-weights-not-supported #' #' @examples diff --git a/R/depth.R b/R/depth.R index 3da344067..b126d919d 100644 --- a/R/depth.R +++ b/R/depth.R @@ -51,10 +51,16 @@ #' replace the original values and by default have the prefix `depth_`. The #' naming format can be changed using the `prefix` argument. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `class` is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `class` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{class}{character, name of class variable} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/discretize.R b/R/discretize.R index 49aa0c892..c7021759d 100644 --- a/R/discretize.R +++ b/R/discretize.R @@ -259,9 +259,14 @@ print.discretize <- #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `value` -#' (the breaks) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{character, the breaks} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_discretize" diff --git a/R/dummy.R b/R/dummy.R index c588710c0..40807703e 100644 --- a/R/dummy.R +++ b/R/dummy.R @@ -67,9 +67,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns `terms` -#' (the selectors or original variables selected) and `columns` (the list of -#' corresponding binary columns) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `columns` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{columns}{character, names of resulting columns} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/dummy_extract.R b/R/dummy_extract.R index fdeb54ea6..ead395781 100644 --- a/R/dummy_extract.R +++ b/R/dummy_extract.R @@ -31,12 +31,16 @@ #' #' @details #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or original variables selected) and `columns` -#' (the list of corresponding columns) is returned. The `columns` is -#' is ordered according the frequency in the training data set. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `columns` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{columns}{character, names of resulting columns} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-unsupervised #' diff --git a/R/dummy_multi_choice.R b/R/dummy_multi_choice.R index 24c7a1f62..b83d12f95 100644 --- a/R/dummy_multi_choice.R +++ b/R/dummy_multi_choice.R @@ -29,6 +29,17 @@ #' cat(result) #' ``` #' +#' # Tidying +#' +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `columns` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{columns}{character, names of resulting columns} +#' \item{id}{character, id of this step} +#' } +#' #' @template case-weights-not-supported #' #' @examples diff --git a/R/factor2string.R b/R/factor2string.R index 8e7df4861..1d2d9adda 100644 --- a/R/factor2string.R +++ b/R/factor2string.R @@ -15,8 +15,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns `terms` -#' (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/filter.R b/R/filter.R index d21f1b6f4..8c9a1ac68 100644 --- a/R/filter.R +++ b/R/filter.R @@ -17,11 +17,15 @@ #' the value of the object in the expression (to be portable #' between sessions). See the examples. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` which contains the conditional statements is returned. -#' These expressions are text representations and are not parsable. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/filter_missing.R b/R/filter_missing.R index 1fd4ad114..4984f1e58 100644 --- a/R/filter_missing.R +++ b/R/filter_missing.R @@ -22,8 +22,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be removed) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_filter_missing" diff --git a/R/geodist.R b/R/geodist.R index b9a14507b..685ba0637 100644 --- a/R/geodist.R +++ b/R/geodist.R @@ -28,9 +28,19 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' echoing the values of `lat`, `lon`, `ref_lat`, `ref_lon`, -#' `is_lat_lon`, `name`, and `id` is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 7 +#' columns `latitude`, `longitude`, `ref_latitude`, `ref_longitude`, +#' `is_lat_lon`, `name` and `id`: +#' +#' \describe{ +#' \item{latitude}{character, name of latitude variable} +#' \item{longitude}{character, name of longitude variable} +#' \item{ref_latitude}{numeric, location of latitude reference point} +#' \item{ref_longitude}{numeric, location of longitude reference point} +#' \item{is_lat_lon}{character, the summary function name} +#' \item{name}{character, name of resulting variable} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/harmonic.R b/R/harmonic.R index f6718c809..e069b3b1a 100644 --- a/R/harmonic.R +++ b/R/harmonic.R @@ -64,6 +64,20 @@ #' cat(result) #' ``` #' +#' # Tidying +#' +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 6 +#' columns `terms`, `starting_val`, `cycle_size`, `frequency`, `key`, and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{starting_val}{numeric, the starting value} +#' \item{cycle_size}{numeric, the cycle size} +#' \item{frequency}{numeric, the frequency} +#' \item{key}{character, key describing the calculation} +#' \item{id}{character, id of this step} +#' } +#' #' @template case-weights-not-supported #' #' @references Doran, H. E., & Quilkey, J. J. (1972). diff --git a/R/holiday.R b/R/holiday.R index c55dff7b7..0f6af7581 100644 --- a/R/holiday.R +++ b/R/holiday.R @@ -17,10 +17,16 @@ #' remove the original date variables by default. Set `keep_original_cols` #' to `FALSE` to remove them. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the columns that will be affected) and `holiday` is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `holiday` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{holiday}{character, name of holidays} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/hyperbolic.R b/R/hyperbolic.R index e381a9c21..e57497b40 100644 --- a/R/hyperbolic.R +++ b/R/hyperbolic.R @@ -15,9 +15,15 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the columns that will be affected), `inverse`, and `func` is -#' returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `inverse`, `func` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{inverse}{logical, is the inverse function be used} +#' \item{func}{character, name of function. "sinh", "cosh", or "tanh"} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/ica.R b/R/ica.R index 400db09b1..2db94e090 100644 --- a/R/ica.R +++ b/R/ica.R @@ -41,9 +41,15 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected), `value` (the loading), -#' and `component` is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `component`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{component}{character, name of component} +#' \item{value}{numeric, the loading} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_ica" diff --git a/R/impute_bag.R b/R/impute_bag.R index dfe0855c8..4a8111fab 100644 --- a/R/impute_bag.R +++ b/R/impute_bag.R @@ -47,6 +47,17 @@ #' `terms` (the selectors or variables selected) and `model` #' (the bagged tree object) is returned. #' +#' # Tidying +#' +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `model` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{model}{list, the bagged tree object} +#' \item{id}{character, id of this step} +#' } +#' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_impute_bag" #' result <- knitr::knit_child("man/rmd/tunable-args.Rmd") diff --git a/R/impute_knn.R b/R/impute_knn.R index 5583467af..2b150c56d 100644 --- a/R/impute_knn.R +++ b/R/impute_knn.R @@ -34,9 +34,15 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables for imputation), `predictors` -#' (those variables used to impute), and `neighbors` is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `predictors`, `neighbors` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{predictors}{character, selected predictors used to impute} +#' \item{neighbors}{integer, number of neighbors} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_impute_knn" diff --git a/R/impute_linear.R b/R/impute_linear.R index d4793f2ec..444bb925e 100644 --- a/R/impute_linear.R +++ b/R/impute_linear.R @@ -26,11 +26,16 @@ #' Since this is a linear regression, the imputation model only uses complete #' cases for the training set predictors. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with -#' columns `terms` (the selectors or variables selected) and `model` (the -#' bagged tree object) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `model` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{model}{list, list of fitted `lm()` models} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-unsupervised #' diff --git a/R/impute_lower.R b/R/impute_lower.R index a67b3d140..08e76cc30 100644 --- a/R/impute_lower.R +++ b/R/impute_lower.R @@ -20,11 +20,16 @@ #' As of `recipes` 0.1.16, this function name changed from `step_lowerimpute()` #' to `step_impute_lower()`. #' -#' # Tidying +#' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `value` for the -#' estimated threshold is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{numeric, the estimated value} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/impute_mean.R b/R/impute_mean.R index a4356b3ba..8569db706 100644 --- a/R/impute_mean.R +++ b/R/impute_mean.R @@ -23,9 +23,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `model` (the mean -#' value) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `model` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{model}{numeric, the mean value} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_impute_mean" diff --git a/R/impute_median.R b/R/impute_median.R index a9e57d41a..7cbb4c8ce 100644 --- a/R/impute_median.R +++ b/R/impute_median.R @@ -20,9 +20,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with -#' columns `terms` (the selectors or variables selected) and `model` -#' (themedian value) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `model` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{model}{numeric, the median value} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-unsupervised #' diff --git a/R/impute_mode.R b/R/impute_mode.R index 287e1b2e1..1d4c790de 100644 --- a/R/impute_mode.R +++ b/R/impute_mode.R @@ -23,9 +23,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `model` (the mode -#' value) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{character, the mode value} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-unsupervised #' diff --git a/R/impute_roll.R b/R/impute_roll.R index 0fb8f05f5..7f64cf967 100644 --- a/R/impute_roll.R +++ b/R/impute_roll.R @@ -37,11 +37,16 @@ #' As of `recipes` 0.1.16, this function name changed from `step_rollimpute()` #' to `step_impute_roll()`. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `window` -#' (the window size) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `window` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{window}{integer, window size} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_impute_roll" diff --git a/R/indicate_na.R b/R/indicate_na.R index 19971799c..06834b968 100644 --- a/R/indicate_na.R +++ b/R/indicate_na.R @@ -13,9 +13,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `model` (the -#' median value) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/integer.R b/R/integer.R index 3f424253f..bd7f73c0e 100644 --- a/R/integer.R +++ b/R/integer.R @@ -31,9 +31,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `value` -#' (a _list column_ with the conversion key) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{list, a _list column_ with the conversion key} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/interact.R b/R/interact.R index dfaa62830..c2a4c5969 100644 --- a/R/interact.R +++ b/R/interact.R @@ -50,8 +50,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the interaction effects) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/intercept.R b/R/intercept.R index 7ad0cb2cc..0690cf2eb 100644 --- a/R/intercept.R +++ b/R/intercept.R @@ -19,10 +19,16 @@ #' @export #' #' @details +#' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/inverse.R b/R/inverse.R index 6cc5664d3..0eaf15b43 100644 --- a/R/inverse.R +++ b/R/inverse.R @@ -14,8 +14,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/invlogit.R b/R/invlogit.R index 3a841dc2f..a8ab44978 100644 --- a/R/invlogit.R +++ b/R/invlogit.R @@ -12,10 +12,15 @@ #' real line and translates them to be between zero and one using #' the function `f(x) = 1/(1+exp(-x))`. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/isomap.R b/R/isomap.R index 7363ccd9b..c451d8976 100644 --- a/R/isomap.R +++ b/R/isomap.R @@ -45,8 +45,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the selectors or variables selected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_isomap" diff --git a/R/kpca.R b/R/kpca.R index 8209762fc..f5ae5312b 100644 --- a/R/kpca.R +++ b/R/kpca.R @@ -26,6 +26,18 @@ #' #' @template kpca-info #' +#' @details +#' +#' # Tidying +#' +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } +#' #' @template case-weights-not-supported #' #' @examplesIf rlang::is_installed(c("modeldata", "ggplot2", "kernlab")) diff --git a/R/kpca_poly.R b/R/kpca_poly.R index 3490e1bde..8a1d5972b 100644 --- a/R/kpca_poly.R +++ b/R/kpca_poly.R @@ -23,6 +23,16 @@ #' cat(result) #' ``` #' +#' # Tidying +#' +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } +#' #' @template case-weights-not-supported #' #' @examplesIf rlang::is_installed(c("modeldata", "ggplot2","kernlab")) diff --git a/R/kpca_rbf.R b/R/kpca_rbf.R index 398e14b85..2d4d84198 100644 --- a/R/kpca_rbf.R +++ b/R/kpca_rbf.R @@ -23,6 +23,16 @@ #' cat(result) #' ``` #' +#' # Tidying +#' +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } +#' #' @template case-weights-not-supported #' #' @examplesIf rlang::is_installed(c("modeldata", "ggplot2", "kernlab")) diff --git a/R/lag.R b/R/lag.R index 9ee8910c8..933ba273c 100644 --- a/R/lag.R +++ b/R/lag.R @@ -18,8 +18,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/lincomb.R b/R/lincomb.R index 4d5647196..36ab48294 100644 --- a/R/lincomb.R +++ b/R/lincomb.R @@ -20,10 +20,15 @@ #' removed to resolve the issue. This algorithm may need to be #' applied multiple times (as defined by `max_steps`). #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be removed) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/log.R b/R/log.R index a53ef49a2..85f90c969 100644 --- a/R/log.R +++ b/R/log.R @@ -18,8 +18,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the columns that will be affected) and `base`. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `base` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{base}{numeric, value for the base} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/logit.R b/R/logit.R index 130a4cc94..706dc19bd 100644 --- a/R/logit.R +++ b/R/logit.R @@ -14,10 +14,15 @@ #' zero and one and translates them to be on the real line using #' the function `f(p) = log(p/(1-p))`. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/mutate.R b/R/mutate.R index 9df346a42..18b469e56 100644 --- a/R/mutate.R +++ b/R/mutate.R @@ -18,11 +18,16 @@ #' If a preceding step removes a column that is selected by name in #' `step_mutate()`, the recipe will error when being estimated with [prep()]. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `values`, which contains the `mutate()` expressions as character -#' strings (and are not reparsable), is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{character, expression passed to `mutate()`} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/mutate_at.R b/R/mutate_at.R index ac2a19c17..e0db3dcee 100644 --- a/R/mutate_at.R +++ b/R/mutate_at.R @@ -16,8 +16,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` which contains the columns being transformed is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/naomit.R b/R/naomit.R index 9b1b6ebaf..366245cc6 100644 --- a/R/naomit.R +++ b/R/naomit.R @@ -10,6 +10,18 @@ #' @param trained A logical to indicate if the quantities for preprocessing #' have been estimated. Again included for consistency. #' +#' @details +#' +#' # Tidying +#' +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } +#' #' @template case-weights-not-supported #' #' @template step-return diff --git a/R/nnmf.R b/R/nnmf.R index b641d2879..85d5d071e 100644 --- a/R/nnmf.R +++ b/R/nnmf.R @@ -39,9 +39,15 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the selectors or variables selected) and the number of -#' components is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `value`, `component` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{numeric, value of loading} +#' \item{component}{character, name of component} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_nnmf" diff --git a/R/nnmf_sparse.R b/R/nnmf_sparse.R index 3692da5c0..e395694d6 100644 --- a/R/nnmf_sparse.R +++ b/R/nnmf_sparse.R @@ -29,11 +29,17 @@ #' cat(result) #' ``` #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the selectors or variables selected) and the number of -#' components is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `value`, `component` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{numeric, value of loading} +#' \item{component}{character, name of component} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_nnmf_sparse" diff --git a/R/normalize.R b/R/normalize.R index bf9ec72c4..57122dff0 100644 --- a/R/normalize.R +++ b/R/normalize.R @@ -21,12 +21,17 @@ #' `prep.recipe`. [`bake.recipe`] then applies the scaling to new data sets using #' these estimates. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected), `value` (the standard -#' deviations and means), and `statistic` for the type of value is -#' returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `statistic`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{statistic}{character, name of statistic, mean or sd} +#' \item{value}{integer, value statistic} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-unsupervised #' diff --git a/R/novel.R b/R/novel.R index f20f40db1..439661960 100644 --- a/R/novel.R +++ b/R/novel.R @@ -33,9 +33,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the columns that will be affected) and `value` (the factor -#' levels that is used for the new value) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{character, the factor levels that is used for the new value} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/ns.R b/R/ns.R index 11efe7ec6..204d46251 100644 --- a/R/ns.R +++ b/R/ns.R @@ -24,10 +24,15 @@ #' from the data and new columns are added. The naming convention #' for the new variables is `varname_ns_1` and so on. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_ns" diff --git a/R/num2factor.R b/R/num2factor.R index ca22f3aef..8bd298824 100644 --- a/R/num2factor.R +++ b/R/num2factor.R @@ -19,8 +19,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `ordered` is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `ordered` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{ordered}{logical, were the factor(s) ordered} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/nzv.R b/R/nzv.R index d1e8fa1a4..e5aa2040a 100644 --- a/R/nzv.R +++ b/R/nzv.R @@ -42,8 +42,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be removed) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_nzv" diff --git a/R/ordinalscore.R b/R/ordinalscore.R index e9ae45b44..46809102a 100644 --- a/R/ordinalscore.R +++ b/R/ordinalscore.R @@ -18,10 +18,15 @@ #' a linear scale (1, 2, 3, ... `C`) but custom score #' functions can also be used (see the example below). #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/other.R b/R/other.R index 62cfa17e9..1eecd292a 100644 --- a/R/other.R +++ b/R/other.R @@ -43,9 +43,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the columns that will be affected) and `retained` (the factor -#' levels that were not pulled into "other") is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `retained` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{retained}{character, factor levels not pulled into "other"} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_other" diff --git a/R/pca.R b/R/pca.R index 58d3b9363..341b721b5 100644 --- a/R/pca.R +++ b/R/pca.R @@ -60,9 +60,26 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, use either `type = "coef"` -#' for the variable loadings per component or `type = "variance"` for how -#' much variance each component accounts for. +#' When you [`tidy()`][tidy.recipe()] this step two things can happen depending +#' the `type` argument. If `type = "coef"` a tibble returned with 4 columns +#' `terms`, `value`, `component` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{numeric, variable loading} +#' \item{component}{character, principle component} +#' \item{id}{character, id of this step} +#' } +#' +#' If `type = "variance"` a tibble returned with 4 columns `terms`, `value`, +#' `component` and `id`: +#' +#' \describe{ +#' \item{terms}{character, type of variance} +#' \item{value}{numeric, value of the variance} +#' \item{component}{integer, principle component} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_pca" @@ -96,6 +113,7 @@ #' #' tidy(pca_trans, number = 2) #' tidy(pca_estimates, number = 2) +#' tidy(pca_estimates, number = 2, type = "variance") step_pca <- function(recipe, ..., role = "predictor", diff --git a/R/percentile.R b/R/percentile.R index 129322a68..a1cf7ec83 100644 --- a/R/percentile.R +++ b/R/percentile.R @@ -20,6 +20,20 @@ #' @export #' @rdname step_percentile #' +#' @details +#' +#' # Tidying +#' +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `value`, `percentile` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{numeric, the value at the percentile} +#' \item{percentile}{numeric, the percentile as a percentage} +#' \item{id}{character, id of this step} +#' } +#' #' @template case-weights-unsupervised #' #' @examplesIf rlang::is_installed("modeldata") diff --git a/R/pls.R b/R/pls.R index 53acc1f76..540421c6a 100644 --- a/R/pls.R +++ b/R/pls.R @@ -41,17 +41,15 @@ #' #' # Tidying #' -#' The [`tidy()`][tidy.recipe()] method returns the coefficients that are -#' usually defined as +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `value`, `component` and `id`: #' -#' \deqn{W(P'W)^{-1}} -#' -#' (See the Wikipedia article below) -#' -#' When applied to data, these values are usually scaled by a column-specific -#' norm. The `tidy()` method applies this same norm to the coefficients shown -#' above. When you `tidy()` this step, a tibble with columns `terms` (the -#' selectors or variables selected), `components`, and `values` is returned. +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{numeric, coeficients defined as \eqn{W(P'W)^{-1}}} +#' \item{size}{character, name of component} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_pls" diff --git a/R/poly.R b/R/poly.R index c5c19c00c..f71eaa0dc 100644 --- a/R/poly.R +++ b/R/poly.R @@ -31,8 +31,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns `terms` -#' (the columns that will be affected) and `degree` is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `degree` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{degree}{integer, the polynomial degree} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_poly" diff --git a/R/poly_bernstein.R b/R/poly_bernstein.R index 2367d8c83..4063c57b2 100644 --- a/R/poly_bernstein.R +++ b/R/poly_bernstein.R @@ -23,8 +23,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_poly_bernstein" diff --git a/R/profile.R b/R/profile.R index 848ebeab9..2b2a93be3 100644 --- a/R/profile.R +++ b/R/profile.R @@ -36,11 +36,16 @@ #' `new_data` argument is ignored; the resulting data set is #' based on the fixed and profiled variable's information. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (which is the columns that will be affected) and `type` (fixed -#' or profiled) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `type` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{type}{character, fixed or profiled} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/range.R b/R/range.R index b43c71fb6..b51fbf424 100644 --- a/R/range.R +++ b/R/range.R @@ -22,11 +22,17 @@ #' the training set, the new values are truncated at `min` or #' `max`. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected), `min`, and `max` is -#' returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `min`, `max` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{min}{numeric, lower range} +#' \item{max}{numeric, upper range} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/ratio.R b/R/ratio.R index 1554395a8..d9ab780d1 100644 --- a/R/ratio.R +++ b/R/ratio.R @@ -27,6 +27,17 @@ #' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns #' `terms` (the selectors or variables selected) and `denom` is returned. #' +#' # Tidying +#' +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `denom` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{denom}{character, name of denominator selected} +#' \item{id}{character, id of this step} +#' } +#' #' @template case-weights-not-supported #' #' @family multivariate transformation steps diff --git a/R/regex.R b/R/regex.R index 3b1bd07e4..5445c1a23 100644 --- a/R/regex.R +++ b/R/regex.R @@ -24,9 +24,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `result` (the -#' new column name) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `result` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{result}{character, new column name} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/relevel.R b/R/relevel.R index b9107dc2a..6f4c124f0 100644 --- a/R/relevel.R +++ b/R/relevel.R @@ -13,12 +13,25 @@ #' @template step-return #' @family dummy variable and encoding steps #' @export -#' @details The selected variables are releveled to a level +#' @details +#' +#' The selected variables are releveled to a level #' (given by `ref_level`). Placing the `ref_level` in the first #' position. #' #' Note that if the original columns are character, they will be -#' converted to factors by this step. +#' converted to factors by this step. +#' +#' # Tidying +#' +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{character, the value of `ref_level`} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/relu.R b/R/relu.R index 7b975945c..30254a9ad 100644 --- a/R/relu.R +++ b/R/relu.R @@ -18,15 +18,17 @@ #' @export #' @rdname step_relu #' -#' @details The rectified linear transformation is calculated as -#' \deqn{max(0, x - c)} and is also known as the ReLu or right hinge function. -#' If `reverse` is true, then the transformation is reflected about the -#' y-axis, like so: \deqn{max(0, c - x)} Setting the `smooth` option -#' to true will instead calculate a smooth approximation to ReLu -#' according to \deqn{ln(1 + e^(x - c)} The `reverse` argument may -#' also be applied to this transformation. +#' @details #' -#' @section Connection to MARS: +#' The rectified linear transformation is calculated as +#' \deqn{max(0, x - c)} and is also known as the ReLu or right hinge function. +#' If `reverse` is true, then the transformation is reflected about the +#' y-axis, like so: \deqn{max(0, c - x)} Setting the `smooth` option +#' to true will instead calculate a smooth approximation to ReLu +#' according to \deqn{ln(1 + e^(x - c)} The `reverse` argument may +#' also be applied to this transformation. +#' +#' # Connection to MARS: #' #' The rectified linear transformation is used in Multivariate Adaptive #' Regression Splines as a basis function to fit piecewise linear functions to @@ -37,6 +39,18 @@ #' in the loss function of Support Vector Machines, where it penalizes #' residuals only if they are within a certain margin of the decision boundary. #' +#' # Tidying +#' +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `shift`, `reverse` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{shift}{numeric, location of hinge} +#' \item{reverse}{logical, whether left hinge is used} +#' \item{id}{character, id of this step} +#' } +#' #' @template case-weights-not-supported #' #' @examplesIf rlang::is_installed("modeldata") diff --git a/R/rename.R b/R/rename.R index edbe5a22b..f96f3d1b9 100644 --- a/R/rename.R +++ b/R/rename.R @@ -16,9 +16,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with -#' columns `values` which contains the `rename` expressions as character -#' strings (and are not reparsable) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{character, `rename` expression} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/rename_at.R b/R/rename_at.R index 5ac4b68e7..ffacfca01 100644 --- a/R/rename_at.R +++ b/R/rename_at.R @@ -15,8 +15,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` which contains the columns being transformed is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/rm.R b/R/rm.R index 271cd1b25..047867263 100644 --- a/R/rm.R +++ b/R/rm.R @@ -13,8 +13,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be removed) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/sample.R b/R/sample.R index b213bc5d0..830e5ca6d 100644 --- a/R/sample.R +++ b/R/sample.R @@ -18,8 +18,15 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `size`, `replace`, and `id` is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `size`, `replace` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{size}{numeric, amount of sampling} +#' \item{replace}{logical, whether sampling is done with replacement} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-unsupervised #' diff --git a/R/scale.R b/R/scale.R index 2aff539ad..91482a694 100644 --- a/R/scale.R +++ b/R/scale.R @@ -23,11 +23,16 @@ #' `bake.recipe` then applies the scaling to new data sets #' using these standard deviations. #' -#' # Tidying +#' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `value` (the -#' standard deviations) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `value`, and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{numeric, the standard deviations} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-unsupervised #' diff --git a/R/select.R b/R/select.R index 1410cf11c..8aa5cdc1c 100644 --- a/R/select.R +++ b/R/select.R @@ -15,9 +15,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` which contains the `select` expressions as character strings -#' (and are not reparsable) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/shuffle.R b/R/shuffle.R index 2229794ce..35ad1b700 100644 --- a/R/shuffle.R +++ b/R/shuffle.R @@ -10,8 +10,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be permuted) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/slice.R b/R/slice.R index 7f5498562..f995d9522 100644 --- a/R/slice.R +++ b/R/slice.R @@ -15,10 +15,15 @@ #' to embed the value of the object in the expression (to #' be portable between sessions). See the examples. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` which contains the filtering indices is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, containing the filtering indexes} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/spatialsign.R b/R/spatialsign.R index 41fce2a3b..73b59c9ee 100644 --- a/R/spatialsign.R +++ b/R/spatialsign.R @@ -20,8 +20,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @section Case weights: #' diff --git a/R/spline_b.R b/R/spline_b.R index a6da03beb..88a02e9e1 100644 --- a/R/spline_b.R +++ b/R/spline_b.R @@ -37,8 +37,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_spline_b" diff --git a/R/spline_convex.R b/R/spline_convex.R index 4a668f938..6a7f2a2c8 100644 --- a/R/spline_convex.R +++ b/R/spline_convex.R @@ -28,8 +28,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_spline_convex" diff --git a/R/spline_monotone.R b/R/spline_monotone.R index 2ad7d1257..a39e01f0d 100644 --- a/R/spline_monotone.R +++ b/R/spline_monotone.R @@ -29,8 +29,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_spline_monotone" diff --git a/R/spline_natural.R b/R/spline_natural.R index 30abf1e55..5112926a0 100644 --- a/R/spline_natural.R +++ b/R/spline_natural.R @@ -27,8 +27,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_spline_natural" diff --git a/R/spline_nonnegative.R b/R/spline_nonnegative.R index 506a2d17b..690bc6be3 100644 --- a/R/spline_nonnegative.R +++ b/R/spline_nonnegative.R @@ -32,8 +32,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_spline_nonnegative" diff --git a/R/sqrt.R b/R/sqrt.R index 36668ca4d..9edda6086 100644 --- a/R/sqrt.R +++ b/R/sqrt.R @@ -11,8 +11,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/string2factor.R b/R/string2factor.R index 36ccbde15..fd51cd4a8 100644 --- a/R/string2factor.R +++ b/R/string2factor.R @@ -44,11 +44,16 @@ #' data will be applied to `step_string2factor()`. However, this step #' can also take existing factors (but will leave them as-is). #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `ordered` is -#' returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `ordered` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{ordered}{logical, are factors ordered} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/time.R b/R/time.R index dbe71e1ea..3aca88a71 100644 --- a/R/time.R +++ b/R/time.R @@ -28,11 +28,16 @@ #' See [step_date()] if you want to calculate features that are larger than #' hours. #' -#' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected) and `value` (the feature -#' names). +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{value}{character, the feature names} +#' \item{id}{character, id of this step} +#' } #' #' @examples #' library(lubridate) diff --git a/R/unknown.R b/R/unknown.R index 5e588272e..9808fe48b 100644 --- a/R/unknown.R +++ b/R/unknown.R @@ -24,9 +24,14 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the columns that will be affected) and `value` (the factor -#' levels that is used for the new value) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' columns `terms`, `value` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{statistic}{character, the factor levels for the new values} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/unorder.R b/R/unorder.R index 7d5b518fc..38ab47ad5 100644 --- a/R/unorder.R +++ b/R/unorder.R @@ -12,8 +12,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be affected) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/R/window.R b/R/window.R index 8bebbc0d4..9029a1a1e 100644 --- a/R/window.R +++ b/R/window.R @@ -44,9 +44,15 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with columns -#' `terms` (the selectors or variables selected), `statistic` (the -#' summary function name), and `size` is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' columns `terms`, `statistic`, `size` and `id`: +#' +#' \describe{ +#' \item{terms}{character, the selectors or variables selected} +#' \item{statistic}{character, the summary function name} +#' \item{size}{integer, window size} +#' \item{id}{character, id of this step} +#' } #' #' ```{r, echo = FALSE, results="asis"} #' step <- "step_window" diff --git a/R/zv.R b/R/zv.R index 7e59fd058..eb5c4c5e9 100644 --- a/R/zv.R +++ b/R/zv.R @@ -18,8 +18,13 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble with column -#' `terms` (the columns that will be removed) is returned. +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' columns `terms` and `id`: +#' +#' \describe{ +#' \item{terms}{character, names of the columns that will be removed} +#' \item{id}{character, id of this step} +#' } #' #' @template case-weights-not-supported #' diff --git a/man/step_BoxCox.Rd b/man/step_BoxCox.Rd index dc7423e31..fde943eca 100644 --- a/man/step_BoxCox.Rd +++ b/man/step_BoxCox.Rd @@ -75,9 +75,14 @@ closed to the bounds, or if the optimization fails, a value of \code{NA} is used and no transformation is applied. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{value} (the -lambda estimate) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{numeric, the lambda estimate} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_YeoJohnson.Rd b/man/step_YeoJohnson.Rd index f094b2830..568a58b24 100644 --- a/man/step_YeoJohnson.Rd +++ b/man/step_YeoJohnson.Rd @@ -78,9 +78,14 @@ closed to the bounds, or if the optimization fails, a value of \code{NA} is used and no transformation is applied. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{value} (the -lambda estimate) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{numeric, the lambda estimate} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_arrange.Rd b/man/step_arrange.Rd index c904ef084..eddf5a09f 100644 --- a/man/step_arrange.Rd +++ b/man/step_arrange.Rd @@ -55,10 +55,13 @@ to embed the value of the object in the expression (to be portable between sessions). See the examples. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} which contains the sorting variable(s) or expression(s) is -returned. The expressions are text representations and are not -parsable. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_bin2factor.Rd b/man/step_bin2factor.Rd index 62b1b4f3e..97aea3fd2 100644 --- a/man/step_bin2factor.Rd +++ b/man/step_bin2factor.Rd @@ -66,8 +66,13 @@ density of numeric binary data. Note that the numeric data is only verified to be numeric (and does not count levels). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_bs.Rd b/man/step_bs.Rd index da774e2ec..4bddb7655 100644 --- a/man/step_bs.Rd +++ b/man/step_bs.Rd @@ -75,8 +75,13 @@ from the data and new columns are added. The naming convention for the new variables is \code{varname_bs_1} and so on. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_center.Rd b/man/step_center.Rd index 9f74a894c..f6bbdc374 100644 --- a/man/step_center.Rd +++ b/man/step_center.Rd @@ -59,9 +59,14 @@ argument of \code{prep.recipe}. \code{bake.recipe} then applies the centering to new data sets using these means. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{value} (the means) -is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{character, the means} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_classdist.Rd b/man/step_classdist.Rd index e030e2ae8..4a97518fb 100644 --- a/man/step_classdist.Rd +++ b/man/step_classdist.Rd @@ -98,9 +98,15 @@ there must be at least as many data points are variables overall. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected), \code{value} (the centroid -of the class), and \code{class} is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{value}, \code{class} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{numeric, location of centroid} +\item{class}{character, name of the class} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_classdist_shrunken.Rd b/man/step_classdist_shrunken.Rd index 3b60e6190..3d70bc140 100644 --- a/man/step_classdist_shrunken.Rd +++ b/man/step_classdist_shrunken.Rd @@ -97,11 +97,20 @@ values and, by default, have the prefix \code{classdist_}. The naming format can be changed using the \code{prefix} argument. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected), \code{value} (the centroid), -\code{class}, and \code{type} is returned. Type has values \code{"global"}, \code{"by_class"}, -and \code{"shrunken"}. The first two types of centroids are in the original units -while the last have been standardized. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 6 +columns \code{terms}, \code{value}, \code{class}, \code{type}, \code{threshold} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{numeric, the centroid} +\item{class}{character, name of class variable} +\item{type}{character, has values global, by_class, and shrunken} +\item{threshold}{numeric, value of threshold} +\item{id}{character, id of this step} +} + +The first two types of centroids are in the original units while the last +have been standardized. } \section{Case weights}{ diff --git a/man/step_corr.Rd b/man/step_corr.Rd index 539b6aa82..a68a18e6a 100644 --- a/man/step_corr.Rd +++ b/man/step_corr.Rd @@ -82,8 +82,13 @@ The arguments \code{use} and \code{method} don't take effect if case weights are used in the recipe. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be removed) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_count.Rd b/man/step_count.Rd index b6bc2acbe..588aae54f 100644 --- a/man/step_count.Rd +++ b/man/step_count.Rd @@ -73,9 +73,14 @@ sequence of any existing operations. variable that counts instances of a regular expression pattern in text. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{result} (the -new column name) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{result} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{result}{character, the new column names} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_cut.Rd b/man/step_cut.Rd index 615843efe..5f658f053 100644 --- a/man/step_cut.Rd +++ b/man/step_cut.Rd @@ -60,6 +60,17 @@ points will end up in the last. \code{step_cut()} will call \code{base::cut()} in the baking step with \code{include.lowest} set to \code{TRUE}. } +\section{Tidying}{ +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{character, the location of the cuts} +\item{id}{character, id of this step} +} +} + \section{Case weights}{ diff --git a/man/step_date.Rd b/man/step_date.Rd index 27d6be8c4..abbb20abe 100644 --- a/man/step_date.Rd +++ b/man/step_date.Rd @@ -96,6 +96,16 @@ days. When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns \code{terms} (the selectors or variables selected), \code{value} (the feature names), and \code{ordinal} (a logical) is returned. + +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{value}, \code{ordinal} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{character, the feature names} +\item{ordinal}{logical, are factors ordered} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_depth.Rd b/man/step_depth.Rd index 4fe2fb005..5730eb3b7 100644 --- a/man/step_depth.Rd +++ b/man/step_depth.Rd @@ -105,8 +105,14 @@ replace the original values and by default have the prefix \code{depth_}. The naming format can be changed using the \code{prefix} argument. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{class} is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{class} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{class}{character, name of class variable} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_discretize.Rd b/man/step_discretize.Rd index 978733528..dfd9bc167 100644 --- a/man/step_discretize.Rd +++ b/man/step_discretize.Rd @@ -67,9 +67,14 @@ convert numeric data into a factor with bins having approximately the same number of data points (based on a training set). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{value} -(the breaks) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{character, the breaks} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_dummy.Rd b/man/step_dummy.Rd index 27e3293aa..d70fdbfeb 100644 --- a/man/step_dummy.Rd +++ b/man/step_dummy.Rd @@ -113,9 +113,14 @@ The \href{https://recipes.tidymodels.org/articles/Dummies.html}{package vignette and interactions has more information. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns \code{terms} -(the selectors or original variables selected) and \code{columns} (the list of -corresponding binary columns) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{columns} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{columns}{character, names of resulting columns} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_dummy_extract.Rd b/man/step_dummy_extract.Rd index e434a6fae..04f2aefdb 100644 --- a/man/step_dummy_extract.Rd +++ b/man/step_dummy_extract.Rd @@ -97,10 +97,14 @@ the \code{naming} argument; the function \code{\link[=dummy_names]{dummy_names() default. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or original variables selected) and \code{columns} -(the list of corresponding columns) is returned. The \code{columns} is -is ordered according the frequency in the training data set. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{columns} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{columns}{character, names of resulting columns} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_dummy_multi_choice.Rd b/man/step_dummy_multi_choice.Rd index 773d918d6..61562d027 100644 --- a/man/step_dummy_multi_choice.Rd +++ b/man/step_dummy_multi_choice.Rd @@ -98,6 +98,17 @@ This step has 1 tuning parameters: } } +\section{Tidying}{ +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{columns} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{columns}{character, names of resulting columns} +\item{id}{character, id of this step} +} +} + \section{Case weights}{ diff --git a/man/step_factor2string.Rd b/man/step_factor2string.Rd index b3655cc6e..bca2a675c 100644 --- a/man/step_factor2string.Rd +++ b/man/step_factor2string.Rd @@ -54,8 +54,13 @@ this step will be converted to factors after all of the steps have been prepped. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns \code{terms} -(the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_filter.Rd b/man/step_filter.Rd index 5858f00dc..e4b587181 100644 --- a/man/step_filter.Rd +++ b/man/step_filter.Rd @@ -67,9 +67,13 @@ before starting a preprocessing \code{\link[=recipe]{recipe()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} which contains the conditional statements is returned. -These expressions are text representations and are not parsable. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_filter_missing.Rd b/man/step_filter_missing.Rd index b3415ecd2..1747ec241 100644 --- a/man/step_filter_missing.Rd +++ b/man/step_filter_missing.Rd @@ -65,8 +65,13 @@ values exceeds the \code{threshold}. All variables with missing values will be removed for \code{threshold = 0}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be removed) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_geodist.Rd b/man/step_geodist.Rd index e940ff6ec..676462b41 100644 --- a/man/step_geodist.Rd +++ b/man/step_geodist.Rd @@ -79,9 +79,19 @@ distances if \code{is_lat_lon} is FALSE. If \code{is_lat_lon} is TRUE, the Haver formula is used to calculate the great-circle distance in meters. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -echoing the values of \code{lat}, \code{lon}, \code{ref_lat}, \code{ref_lon}, -\code{is_lat_lon}, \code{name}, and \code{id} is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 7 +columns \code{latitude}, \code{longitude}, \code{ref_latitude}, \code{ref_longitude}, +\code{is_lat_lon}, \code{name} and \code{id}: + +\describe{ +\item{latitude}{character, name of latitude variable} +\item{longitude}{character, name of longitude variable} +\item{ref_latitude}{numeric, location of latitude reference point} +\item{ref_longitude}{numeric, location of longitude reference point} +\item{is_lat_lon}{character, the summary function name} +\item{name}{character, name of resulting variable} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_harmonic.Rd b/man/step_harmonic.Rd index 9f40210e9..8eeb21055 100644 --- a/man/step_harmonic.Rd +++ b/man/step_harmonic.Rd @@ -112,6 +112,20 @@ This step has 1 tuning parameters: } } +\section{Tidying}{ +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 6 +columns \code{terms}, \code{starting_val}, \code{cycle_size}, \code{frequency}, \code{key}, and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{starting_val}{numeric, the starting value} +\item{cycle_size}{numeric, the cycle size} +\item{frequency}{numeric, the frequency} +\item{key}{character, key describing the calculation} +\item{id}{character, id of this step} +} +} + \section{Case weights}{ diff --git a/man/step_holiday.Rd b/man/step_holiday.Rd index 59077a429..07a90aca0 100644 --- a/man/step_holiday.Rd +++ b/man/step_holiday.Rd @@ -64,8 +64,14 @@ remove the original date variables by default. Set \code{keep_original_cols} to \code{FALSE} to remove them. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the columns that will be affected) and \code{holiday} is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{holiday} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{holiday}{character, name of holidays} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_hyperbolic.Rd b/man/step_hyperbolic.Rd index 18cf7ae80..88a5930c8 100644 --- a/man/step_hyperbolic.Rd +++ b/man/step_hyperbolic.Rd @@ -55,9 +55,15 @@ sequence of any existing operations. transform data using a hyperbolic function. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the columns that will be affected), \code{inverse}, and \code{func} is -returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{inverse}, \code{func} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{inverse}{logical, is the inverse function be used} +\item{func}{character, name of function. "sinh", "cosh", or "tanh"} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_ica.Rd b/man/step_ica.Rd index a8b2c2f1f..536d88982 100644 --- a/man/step_ica.Rd +++ b/man/step_ica.Rd @@ -103,9 +103,15 @@ sequence of numbers. The variable names are padded with zeros. For example, if the names would be \code{IC1} - \code{IC101}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected), \code{value} (the loading), -and \code{component} is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{component}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{component}{character, name of component} +\item{value}{numeric, the loading} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_impute_bag.Rd b/man/step_impute_bag.Rd index f7ff0154f..48a94f5c9 100644 --- a/man/step_impute_bag.Rd +++ b/man/step_impute_bag.Rd @@ -108,6 +108,15 @@ to \code{step_impute_bag()}. When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns \code{terms} (the selectors or variables selected) and \code{model} (the bagged tree object) is returned. + +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{model} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{model}{list, the bagged tree object} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_impute_knn.Rd b/man/step_impute_knn.Rd index a444a942c..980bb88cf 100644 --- a/man/step_impute_knn.Rd +++ b/man/step_impute_knn.Rd @@ -102,9 +102,15 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_knnimput to \code{step_impute_knn()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables for imputation), \code{predictors} -(those variables used to impute), and \code{neighbors} is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{predictors}, \code{neighbors} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{predictors}{character, selected predictors used to impute} +\item{neighbors}{integer, number of neighbors} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_impute_linear.Rd b/man/step_impute_linear.Rd index 03aeb38be..b80b363dd 100644 --- a/man/step_impute_linear.Rd +++ b/man/step_impute_linear.Rd @@ -70,9 +70,14 @@ Since this is a linear regression, the imputation model only uses complete cases for the training set predictors. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with -columns \code{terms} (the selectors or variables selected) and \code{model} (the -bagged tree object) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{model} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{model}{list, list of fitted \code{lm()} models} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_impute_lower.Rd b/man/step_impute_lower.Rd index 34d6b84a6..49ced7676 100644 --- a/man/step_impute_lower.Rd +++ b/man/step_impute_lower.Rd @@ -69,13 +69,18 @@ with a random uniform value between zero and the minimum. As of \code{recipes} 0.1.16, this function name changed from \code{step_lowerimpute()} to \code{step_impute_lower()}. + +#' # Tidying + +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{numeric, the estimated value} +\item{id}{character, id of this step} } -\section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{value} for the -estimated threshold is returned. } - \section{Case weights}{ diff --git a/man/step_impute_mean.Rd b/man/step_impute_mean.Rd index ddf5a866f..288e45540 100644 --- a/man/step_impute_mean.Rd +++ b/man/step_impute_mean.Rd @@ -75,9 +75,14 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_meanimpu to \code{step_impute_mean()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{model} (the mean -value) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{model} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{model}{numeric, the mean value} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_impute_median.Rd b/man/step_impute_median.Rd index 1aa9fe204..95afed9f5 100644 --- a/man/step_impute_median.Rd +++ b/man/step_impute_median.Rd @@ -69,9 +69,14 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_medianimpute()} to \code{step_impute_median()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with -columns \code{terms} (the selectors or variables selected) and \code{model} -(themedian value) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{model} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{model}{numeric, the median value} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_impute_mode.Rd b/man/step_impute_mode.Rd index 2a003c487..dcb2587a5 100644 --- a/man/step_impute_mode.Rd +++ b/man/step_impute_mode.Rd @@ -75,9 +75,14 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_modeimpu to \code{step_impute_mode()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{model} (the mode -value) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{character, the mode value} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_impute_roll.Rd b/man/step_impute_roll.Rd index f875a6d6b..e3a6386a7 100644 --- a/man/step_impute_roll.Rd +++ b/man/step_impute_roll.Rd @@ -92,9 +92,14 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_rollimpu to \code{step_impute_roll()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{window} -(the window size) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{window} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{window}{integer, window size} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_indicate_na.Rd b/man/step_indicate_na.Rd index b9c1849e4..87a7bb4f2 100644 --- a/man/step_indicate_na.Rd +++ b/man/step_indicate_na.Rd @@ -58,9 +58,13 @@ create and append additional binary columns to the data set to indicate which observations are missing. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{model} (the -median value) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_integer.Rd b/man/step_integer.Rd index 9d1dcc85a..ab331572a 100644 --- a/man/step_integer.Rd +++ b/man/step_integer.Rd @@ -73,9 +73,14 @@ Despite the name, the new values are returned as numeric unless \code{strict = TRUE}, which will coerce the results to integers. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{value} -(a \emph{list column} with the conversion key) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{list, a \emph{list column} with the conversion key} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_interact.Rd b/man/step_interact.Rd index a064d1a69..09fd387b4 100644 --- a/man/step_interact.Rd +++ b/man/step_interact.Rd @@ -93,8 +93,13 @@ so that the formula is now \code{(x_2 + x_3 + x_4 + x_5 + x_6):z} and all two-way interactions are created. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the interaction effects) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_intercept.Rd b/man/step_intercept.Rd index 027bae05e..24e5358ce 100644 --- a/man/step_intercept.Rd +++ b/man/step_intercept.Rd @@ -55,8 +55,13 @@ only called in the bake step. Be careful to avoid unintentional transformations when calling steps with \code{all_predictors()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_inverse.Rd b/man/step_inverse.Rd index 4bf1ec62a..c1c9b4b74 100644 --- a/man/step_inverse.Rd +++ b/man/step_inverse.Rd @@ -52,8 +52,13 @@ sequence of any existing operations. transform the data. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_invlogit.Rd b/man/step_invlogit.Rd index 94e8a6e37..02d3e5772 100644 --- a/man/step_invlogit.Rd +++ b/man/step_invlogit.Rd @@ -53,8 +53,13 @@ real line and translates them to be between zero and one using the function \code{f(x) = 1/(1+exp(-x))}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_isomap.Rd b/man/step_isomap.Rd index f1ea7493a..cdc4b63af 100644 --- a/man/step_isomap.Rd +++ b/man/step_isomap.Rd @@ -100,8 +100,13 @@ if \code{num_terms < 10}, their names will be \code{Isomap1} - \code{Isomap001} - \code{Isomap101}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the selectors or variables selected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_kpca.Rd b/man/step_kpca.Rd index 1b5fc8de6..d70cf6bf8 100644 --- a/man/step_kpca.Rd +++ b/man/step_kpca.Rd @@ -110,6 +110,16 @@ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column \code{terms} (the selectors or variables selected) is returned. } +\section{Tidying}{ +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} +} + \section{Case weights}{ diff --git a/man/step_kpca_poly.Rd b/man/step_kpca_poly.Rd index 7034dc8d2..a1fcc8d01 100644 --- a/man/step_kpca_poly.Rd +++ b/man/step_kpca_poly.Rd @@ -112,6 +112,16 @@ This step has 4 tuning parameters: } } +\section{Tidying}{ +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} +} + \section{Case weights}{ diff --git a/man/step_kpca_rbf.Rd b/man/step_kpca_rbf.Rd index fc353d2f2..7059930a2 100644 --- a/man/step_kpca_rbf.Rd +++ b/man/step_kpca_rbf.Rd @@ -108,6 +108,16 @@ This step has 2 tuning parameters: } } +\section{Tidying}{ +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} +} + \section{Case weights}{ diff --git a/man/step_lag.Rd b/man/step_lag.Rd index 0c8d2bbdd..c0a78462c 100644 --- a/man/step_lag.Rd +++ b/man/step_lag.Rd @@ -70,8 +70,13 @@ The step assumes that the data are already \emph{in the proper sequential order} for lagging. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_lincomb.Rd b/man/step_lincomb.Rd index 811b5517e..3ea35f080 100644 --- a/man/step_lincomb.Rd +++ b/man/step_lincomb.Rd @@ -64,8 +64,13 @@ removed to resolve the issue. This algorithm may need to be applied multiple times (as defined by \code{max_steps}). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be removed) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_log.Rd b/man/step_log.Rd index 5a7d313c7..3c8fb2cae 100644 --- a/man/step_log.Rd +++ b/man/step_log.Rd @@ -60,8 +60,14 @@ sequence of any existing operations. transform data. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the columns that will be affected) and \code{base}. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{base} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{base}{numeric, value for the base} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_logit.Rd b/man/step_logit.Rd index f31244ece..5240e6f49 100644 --- a/man/step_logit.Rd +++ b/man/step_logit.Rd @@ -57,8 +57,13 @@ zero and one and translates them to be on the real line using the function \code{f(p) = log(p/(1-p))}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_mutate.Rd b/man/step_mutate.Rd index 4ffac03f9..cc14b4662 100644 --- a/man/step_mutate.Rd +++ b/man/step_mutate.Rd @@ -62,9 +62,14 @@ If a preceding step removes a column that is selected by name in \code{step_mutate()}, the recipe will error when being estimated with \code{\link[=prep]{prep()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{values}, which contains the \code{mutate()} expressions as character -strings (and are not reparsable), is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{character, expression passed to \code{mutate()}} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_mutate_at.Rd b/man/step_mutate_at.Rd index c8c695764..8118d31aa 100644 --- a/man/step_mutate_at.Rd +++ b/man/step_mutate_at.Rd @@ -60,8 +60,13 @@ When applied to new data or testing data, this transformation would use the mean of \code{w} from the \emph{new} data, not the mean of \code{w} from the training data. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} which contains the columns being transformed is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_naomit.Rd b/man/step_naomit.Rd index b4b10e887..41b0659b5 100644 --- a/man/step_naomit.Rd +++ b/man/step_naomit.Rd @@ -57,6 +57,16 @@ not be applied at all; instead, execute operations like this outside and before starting a preprocessing \code{\link[=recipe]{recipe()}}. } +\section{Tidying}{ +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} +} + \section{Case weights}{ diff --git a/man/step_nnmf.Rd b/man/step_nnmf.Rd index eff3dd0e5..4123a62f5 100644 --- a/man/step_nnmf.Rd +++ b/man/step_nnmf.Rd @@ -99,9 +99,15 @@ sequence of numbers. The variable names are padded with zeros. For example, if the names would be \code{NNMF1} - \code{NNMF101}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the selectors or variables selected) and the number of -components is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{value}, \code{component} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{numeric, value of loading} +\item{component}{character, name of component} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_nnmf_sparse.Rd b/man/step_nnmf_sparse.Rd index f81374b49..8882f77ce 100644 --- a/man/step_nnmf_sparse.Rd +++ b/man/step_nnmf_sparse.Rd @@ -91,9 +91,15 @@ sequence of numbers. The variable names are padded with zeros. For example, if the names would be \code{NNMF1} - \code{NNMF101}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the selectors or variables selected) and the number of -components is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{value}, \code{component} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{numeric, value of loading} +\item{component}{character, name of component} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_normalize.Rd b/man/step_normalize.Rd index f8401238a..40d2c3842 100644 --- a/man/step_normalize.Rd +++ b/man/step_normalize.Rd @@ -65,10 +65,15 @@ deviations and means from the data used in the \code{training} argument of these estimates. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected), \code{value} (the standard -deviations and means), and \code{statistic} for the type of value is -returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{statistic}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{statistic}{character, name of statistic, mean or sd} +\item{value}{integer, value statistic} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_novel.Rd b/man/step_novel.Rd index 9947d9bee..c7dd79890 100644 --- a/man/step_novel.Rd +++ b/man/step_novel.Rd @@ -72,9 +72,14 @@ When fitting a model that can deal with new factor levels, consider using new levels at prediction time, instead of throwing warnings or errors. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the columns that will be affected) and \code{value} (the factor -levels that is used for the new value) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{character, the factor levels that is used for the new value} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_ns.Rd b/man/step_ns.Rd index 4670849cd..77c9f1968 100644 --- a/man/step_ns.Rd +++ b/man/step_ns.Rd @@ -72,8 +72,13 @@ from the data and new columns are added. The naming convention for the new variables is \code{varname_ns_1} and so on. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_num2factor.Rd b/man/step_num2factor.Rd index aebb578cc..a558b136b 100644 --- a/man/step_num2factor.Rd +++ b/man/step_num2factor.Rd @@ -60,8 +60,14 @@ sequence of any existing operations. integers. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{ordered} is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{ordered} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{ordered}{logical, were the factor(s) ordered} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_nzv.Rd b/man/step_nzv.Rd index 4306fde09..ed3e83330 100644 --- a/man/step_nzv.Rd +++ b/man/step_nzv.Rd @@ -88,8 +88,13 @@ In the above example, the frequency ratio is 999 and the unique value percent is 0.2\%. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be removed) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_ordinalscore.Rd b/man/step_ordinalscore.Rd index c3ffcd57e..f282b9ad7 100644 --- a/man/step_ordinalscore.Rd +++ b/man/step_ordinalscore.Rd @@ -61,8 +61,13 @@ a linear scale (1, 2, 3, ... \code{C}) but custom score functions can also be used (see the example below). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_other.Rd b/man/step_other.Rd index 4a675a654..a5a4b3421 100644 --- a/man/step_other.Rd +++ b/man/step_other.Rd @@ -84,9 +84,14 @@ When data to be processed contains novel levels (i.e., not contained in the training set), the other category is assigned. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the columns that will be affected) and \code{retained} (the factor -levels that were not pulled into "other") is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{retained} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{retained}{character, factor levels not pulled into "other"} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_pca.Rd b/man/step_pca.Rd index 9cd664cd5..679b978c5 100644 --- a/man/step_pca.Rd +++ b/man/step_pca.Rd @@ -106,9 +106,26 @@ number of components that are required to capture a specified fraction of the total variance in the variables. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, use either \code{type = "coef"} -for the variable loadings per component or \code{type = "variance"} for how -much variance each component accounts for. +When you \code{\link[=tidy.recipe]{tidy()}} this step two things can happen depending +the \code{type} argument. If \code{type = "coef"} a tibble returned with 4 columns +\code{terms}, \code{value}, \code{component} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{numeric, variable loading} +\item{component}{character, principle component} +\item{id}{character, id of this step} +} + +If \code{type = "variance"} a tibble returned with 4 columns \code{terms}, \code{value}, +\code{component} and \code{id}: + +\describe{ +\item{terms}{character, type of variance} +\item{value}{numeric, value of the variance} +\item{component}{integer, principle component} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ @@ -149,6 +166,7 @@ bake(with_thresh, USArrests) tidy(pca_trans, number = 2) tidy(pca_estimates, number = 2) +tidy(pca_estimates, number = 2, type = "variance") } \references{ Jolliffe, I. T. (2010). \emph{Principal Component diff --git a/man/step_percentile.Rd b/man/step_percentile.Rd index ffd60b55b..3b890ba63 100644 --- a/man/step_percentile.Rd +++ b/man/step_percentile.Rd @@ -60,6 +60,18 @@ sequence of any existing operations. \code{step_percentile()} creates a \emph{specification} of a recipe step that replaces the value of a variable with its percentile from the training set. } +\section{Tidying}{ +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{value}, \code{percentile} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{numeric, the value at the percentile} +\item{percentile}{numeric, the percentile as a percentage} +\item{id}{character, id of this step} +} +} + \section{Case weights}{ diff --git a/man/step_pls.Rd b/man/step_pls.Rd index 18eac025e..d69ac9b97 100644 --- a/man/step_pls.Rd +++ b/man/step_pls.Rd @@ -107,17 +107,15 @@ proportion to determine the \code{keepX} parameter in \code{mixOmics::spls()} an \code{mixOmics::splsda()}. See the references in \code{mixOmics::spls()} for details. } \section{Tidying}{ -The \code{\link[=tidy.recipe]{tidy()}} method returns the coefficients that are -usually defined as - -\deqn{W(P'W)^{-1}} - -(See the Wikipedia article below) - -When applied to data, these values are usually scaled by a column-specific -norm. The \code{tidy()} method applies this same norm to the coefficients shown -above. When you \code{tidy()} this step, a tibble with columns \code{terms} (the -selectors or variables selected), \code{components}, and \code{values} is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{value}, \code{component} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{numeric, coeficients defined as \eqn{W(P'W)^{-1}}} +\item{size}{character, name of component} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_poly.Rd b/man/step_poly.Rd index 0bd4ab3a3..6ce3874eb 100644 --- a/man/step_poly.Rd +++ b/man/step_poly.Rd @@ -75,8 +75,14 @@ otherwise be a problem for large values of \code{degree}. Orthogonal polynomial expansion pick up the same signal as their uncorrelated counterpart. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns \code{terms} -(the columns that will be affected) and \code{degree} is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{degree} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{degree}{integer, the polynomial degree} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_poly_bernstein.Rd b/man/step_poly_bernstein.Rd index b7ab2f3f8..ef2b5fd89 100644 --- a/man/step_poly_bernstein.Rd +++ b/man/step_poly_bernstein.Rd @@ -75,8 +75,13 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_profile.Rd b/man/step_profile.Rd index 7653d4a6c..365404d6f 100644 --- a/man/step_profile.Rd +++ b/man/step_profile.Rd @@ -88,9 +88,14 @@ This step is atypical in that, when baked, the based on the fixed and profiled variable's information. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (which is the columns that will be affected) and \code{type} (fixed -or profiled) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{type} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{type}{character, fixed or profiled} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_range.Rd b/man/step_range.Rd index c41d1b484..b5ce1f59e 100644 --- a/man/step_range.Rd +++ b/man/step_range.Rd @@ -68,9 +68,15 @@ the training set, the new values are truncated at \code{min} or \code{max}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected), \code{min}, and \code{max} is -returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{min}, \code{max} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{min}{numeric, lower range} +\item{max}{numeric, upper range} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_ratio.Rd b/man/step_ratio.Rd index 30f545818..e1598a0b2 100644 --- a/man/step_ratio.Rd +++ b/man/step_ratio.Rd @@ -75,6 +75,15 @@ one or more ratios from selected numeric variables. \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns \code{terms} (the selectors or variables selected) and \code{denom} is returned. + +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{denom} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{denom}{character, name of denominator selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_regex.Rd b/man/step_regex.Rd index d23a57e4b..81c94643f 100644 --- a/man/step_regex.Rd +++ b/man/step_regex.Rd @@ -69,9 +69,14 @@ sequence of any existing operations. new dummy variable based on a regular expression. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{result} (the -new column name) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{result} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{result}{character, new column name} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_relevel.Rd b/man/step_relevel.Rd index e1f99c512..7ff1f230a 100644 --- a/man/step_relevel.Rd +++ b/man/step_relevel.Rd @@ -61,6 +61,17 @@ position. Note that if the original columns are character, they will be converted to factors by this step. } +\section{Tidying}{ +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{character, the value of \code{ref_level}} +\item{id}{character, id of this step} +} +} + \section{Case weights}{ diff --git a/man/step_relu.Rd b/man/step_relu.Rd index 04e84cee0..bf834ad11 100644 --- a/man/step_relu.Rd +++ b/man/step_relu.Rd @@ -73,9 +73,7 @@ to true will instead calculate a smooth approximation to ReLu according to \deqn{ln(1 + e^(x - c)} The \code{reverse} argument may also be applied to this transformation. } -\section{Connection to MARS}{ - - +\section{Connection to MARS:}{ The rectified linear transformation is used in Multivariate Adaptive Regression Splines as a basis function to fit piecewise linear functions to data in a strategy similar to that employed in tree based models. The @@ -86,6 +84,18 @@ in the loss function of Support Vector Machines, where it penalizes residuals only if they are within a certain margin of the decision boundary. } +\section{Tidying}{ +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{shift}, \code{reverse} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{shift}{numeric, location of hinge} +\item{reverse}{logical, whether left hinge is used} +\item{id}{character, id of this step} +} +} + \section{Case weights}{ diff --git a/man/step_rename.Rd b/man/step_rename.Rd index 59172e7fa..96cde5769 100644 --- a/man/step_rename.Rd +++ b/man/step_rename.Rd @@ -54,9 +54,14 @@ quasiquotation (e.g. \verb{!!}) to embed the value of the object in the expression (to be portable between sessions). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with -columns \code{values} which contains the \code{rename} expressions as character -strings (and are not reparsable) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{character, \code{rename} expression} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_rename_at.Rd b/man/step_rename_at.Rd index a36b7a78d..3198041f5 100644 --- a/man/step_rename_at.Rd +++ b/man/step_rename_at.Rd @@ -54,8 +54,13 @@ rename the selected variables using a common function via \code{\link[dplyr:select_all]{dplyr::rename_at()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} which contains the columns being transformed is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_rm.Rd b/man/step_rm.Rd index c401ba549..c6397284c 100644 --- a/man/step_rm.Rd +++ b/man/step_rm.Rd @@ -55,8 +55,13 @@ specifically referenced by name. To avoid this, see the advice in the \emph{Tips for saving recipes and filtering columns} section of \link{selections}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be removed) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_sample.Rd b/man/step_sample.Rd index 7314e238b..9f36042b5 100644 --- a/man/step_sample.Rd +++ b/man/step_sample.Rd @@ -65,8 +65,15 @@ before starting a preprocessing \code{\link[=recipe]{recipe()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{size}, \code{replace}, and \code{id} is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{size}, \code{replace} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{size}{numeric, amount of sampling} +\item{replace}{logical, whether sampling is done with replacement} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_scale.Rd b/man/step_scale.Rd index a3d3dd5ed..7b926a92a 100644 --- a/man/step_scale.Rd +++ b/man/step_scale.Rd @@ -65,13 +65,18 @@ the variable standard deviations from the data used in the \code{training} argument of \code{prep.recipe}. \code{bake.recipe} then applies the scaling to new data sets using these standard deviations. + +#' # Tidying + +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{value}, and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{numeric, the standard deviations} +\item{id}{character, id of this step} } -\section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{value} (the -standard deviations) is returned. } - \section{Case weights}{ diff --git a/man/step_select.Rd b/man/step_select.Rd index c38665d4d..22dd78921 100644 --- a/man/step_select.Rd +++ b/man/step_select.Rd @@ -56,9 +56,13 @@ specifically referenced by name. To avoid this, see the advice in the \emph{Tips for saving recipes and filtering columns} section of \link{selections}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} which contains the \code{select} expressions as character strings -(and are not reparsable) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_shuffle.Rd b/man/step_shuffle.Rd index cc530874b..793489965 100644 --- a/man/step_shuffle.Rd +++ b/man/step_shuffle.Rd @@ -48,8 +48,13 @@ sequence of any existing operations. randomly change the order of rows for selected variables. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be permuted) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_slice.Rd b/man/step_slice.Rd index 9423521e9..1c84268f9 100644 --- a/man/step_slice.Rd +++ b/man/step_slice.Rd @@ -65,8 +65,13 @@ before starting a preprocessing \code{\link[=recipe]{recipe()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} which contains the filtering indices is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, containing the filtering indexes} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_spatialsign.Rd b/man/step_spatialsign.Rd index 398664334..a0d1771f3 100644 --- a/man/step_spatialsign.Rd +++ b/man/step_spatialsign.Rd @@ -62,8 +62,13 @@ The variables should be centered and scaled prior to the computations. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_spline_b.Rd b/man/step_spline_b.Rd index 6563d6093..eda57378b 100644 --- a/man/step_spline_b.Rd +++ b/man/step_spline_b.Rd @@ -81,8 +81,13 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_spline_convex.Rd b/man/step_spline_convex.Rd index 06ba4bc4a..45ff28851 100644 --- a/man/step_spline_convex.Rd +++ b/man/step_spline_convex.Rd @@ -85,8 +85,13 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_spline_monotone.Rd b/man/step_spline_monotone.Rd index a1de73834..d81a60712 100644 --- a/man/step_spline_monotone.Rd +++ b/man/step_spline_monotone.Rd @@ -86,8 +86,13 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_spline_natural.Rd b/man/step_spline_natural.Rd index 744dddec9..554a2e983 100644 --- a/man/step_spline_natural.Rd +++ b/man/step_spline_natural.Rd @@ -79,8 +79,13 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_spline_nonnegative.Rd b/man/step_spline_nonnegative.Rd index 1000ea053..b494b10b1 100644 --- a/man/step_spline_nonnegative.Rd +++ b/man/step_spline_nonnegative.Rd @@ -89,8 +89,13 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_sqrt.Rd b/man/step_sqrt.Rd index f11bad88f..e52288d95 100644 --- a/man/step_sqrt.Rd +++ b/man/step_sqrt.Rd @@ -48,8 +48,13 @@ sequence of any existing operations. square root transform to the variables. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_string2factor.Rd b/man/step_string2factor.Rd index eaf38f712..4a7289b6f 100644 --- a/man/step_string2factor.Rd +++ b/man/step_string2factor.Rd @@ -83,9 +83,14 @@ can also take existing factors (but will leave them as-is). } } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{ordered} is -returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{ordered} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{ordered}{logical, are factors ordered} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_time.Rd b/man/step_time.Rd index 05f948fb2..eca53df19 100644 --- a/man/step_time.Rd +++ b/man/step_time.Rd @@ -72,9 +72,14 @@ See \code{\link[=step_date]{step_date()}} if you want to calculate features that hours. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected) and \code{value} (the feature -names). +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{value}{character, the feature names} +\item{id}{character, id of this step} +} } \examples{ diff --git a/man/step_unknown.Rd b/man/step_unknown.Rd index 6fd549d27..82486e43e 100644 --- a/man/step_unknown.Rd +++ b/man/step_unknown.Rd @@ -63,9 +63,14 @@ If \code{new_level} is already in the data given to \code{prep}, an error is thrown. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the columns that will be affected) and \code{value} (the factor -levels that is used for the new value) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +columns \code{terms}, \code{value} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{statistic}{character, the factor levels for the new values} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_unorder.Rd b/man/step_unorder.Rd index c0afd63b6..60698c4f9 100644 --- a/man/step_unorder.Rd +++ b/man/step_unorder.Rd @@ -51,8 +51,13 @@ ordered factor variables into unordered factor variables. The factors level order is preserved during the transformation. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be affected) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{id}{character, id of this step} +} } \section{Case weights}{ diff --git a/man/step_window.Rd b/man/step_window.Rd index 1a160e18b..7791fe67c 100644 --- a/man/step_window.Rd +++ b/man/step_window.Rd @@ -93,9 +93,15 @@ uses \code{median(x[2:6])}. step will stop with a note about installing the package. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns -\code{terms} (the selectors or variables selected), \code{statistic} (the -summary function name), and \code{size} is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +columns \code{terms}, \code{statistic}, \code{size} and \code{id}: + +\describe{ +\item{terms}{character, the selectors or variables selected} +\item{statistic}{character, the summary function name} +\item{size}{integer, window size} +\item{id}{character, id of this step} +} } \section{Tuning Parameters}{ diff --git a/man/step_zv.Rd b/man/step_zv.Rd index 9ae8f55d4..c120e6a76 100644 --- a/man/step_zv.Rd +++ b/man/step_zv.Rd @@ -62,8 +62,13 @@ specifically referenced by name. To avoid this, see the advice in the \emph{Tips for saving recipes and filtering columns} section of \link{selections}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column -\code{terms} (the columns that will be removed) is returned. +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +columns \code{terms} and \code{id}: + +\describe{ +\item{terms}{character, names of the columns that will be removed} +\item{id}{character, id of this step} +} } \section{Case weights}{ From 7b675562c91a0cedffe85dfe987231441fb991e2 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Tue, 3 Oct 2023 14:17:59 -0700 Subject: [PATCH 02/12] add news --- NEWS.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/NEWS.md b/NEWS.md index 45d4c11a4..75439c4d8 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,6 +2,8 @@ * Document that `update_role()`, `add_role()` and `remove_role()` are applied before steps and checks. (#778) +* Documentation for tidy methods for all steps have been added when missing and improved to describe whole outcome. (#936) + # recipes 1.0.8 ## Improvements From 410cf388a9afaac9e11d3b21ae0bb63b9b49fd19 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Tue, 3 Oct 2023 14:34:44 -0700 Subject: [PATCH 03/12] Apply suggestions from code review --- R/center.R | 2 +- R/discretize.R | 2 +- R/normalize.R | 2 +- R/scale.R | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/R/center.R b/R/center.R index 6669991af..48f42cc50 100644 --- a/R/center.R +++ b/R/center.R @@ -39,7 +39,7 @@ #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} -#' \item{value}{character, the means} +#' \item{value}{numeric, the means} #' \item{id}{character, id of this step} #' } #' diff --git a/R/discretize.R b/R/discretize.R index c7021759d..a33d99a9d 100644 --- a/R/discretize.R +++ b/R/discretize.R @@ -264,7 +264,7 @@ print.discretize <- #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} -#' \item{value}{character, the breaks} +#' \item{value}{numeric, the breaks} #' \item{id}{character, id of this step} #' } #' diff --git a/R/normalize.R b/R/normalize.R index 57122dff0..e2d95136f 100644 --- a/R/normalize.R +++ b/R/normalize.R @@ -29,7 +29,7 @@ #' \describe{ #' \item{terms}{character, the selectors or variables selected} #' \item{statistic}{character, name of statistic, mean or sd} -#' \item{value}{integer, value statistic} +#' \item{value}{numeric, value statistic} #' \item{id}{character, id of this step} #' } #' diff --git a/R/scale.R b/R/scale.R index 91482a694..1c201ffe9 100644 --- a/R/scale.R +++ b/R/scale.R @@ -23,9 +23,9 @@ #' `bake.recipe` then applies the scaling to new data sets #' using these standard deviations. #' -#' #' # Tidying +#' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 #' columns `terms`, `value`, and `id`: #' #' \describe{ From d7ce1278c14ad8660184d418e43f8f54bab57de9 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Tue, 3 Oct 2023 14:35:15 -0700 Subject: [PATCH 04/12] reknit --- R/impute_lower.R | 2 +- man/step_center.Rd | 2 +- man/step_discretize.Rd | 2 +- man/step_impute_lower.Rd | 6 +++--- man/step_normalize.Rd | 2 +- man/step_scale.Rd | 8 ++++---- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/R/impute_lower.R b/R/impute_lower.R index 08e76cc30..95cb341a9 100644 --- a/R/impute_lower.R +++ b/R/impute_lower.R @@ -20,7 +20,7 @@ #' As of `recipes` 0.1.16, this function name changed from `step_lowerimpute()` #' to `step_impute_lower()`. #' -#' #' # Tidying +#' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 #' columns `terms`, `value` and `id`: diff --git a/man/step_center.Rd b/man/step_center.Rd index f6bbdc374..b37204242 100644 --- a/man/step_center.Rd +++ b/man/step_center.Rd @@ -64,7 +64,7 @@ columns \code{terms}, \code{value} and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} -\item{value}{character, the means} +\item{value}{numeric, the means} \item{id}{character, id of this step} } } diff --git a/man/step_discretize.Rd b/man/step_discretize.Rd index dfd9bc167..f637291c8 100644 --- a/man/step_discretize.Rd +++ b/man/step_discretize.Rd @@ -72,7 +72,7 @@ columns \code{terms}, \code{value} and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} -\item{value}{character, the breaks} +\item{value}{numeric, the breaks} \item{id}{character, id of this step} } } diff --git a/man/step_impute_lower.Rd b/man/step_impute_lower.Rd index 49ced7676..f3eddab9e 100644 --- a/man/step_impute_lower.Rd +++ b/man/step_impute_lower.Rd @@ -69,9 +69,8 @@ with a random uniform value between zero and the minimum. As of \code{recipes} 0.1.16, this function name changed from \code{step_lowerimpute()} to \code{step_impute_lower()}. - -#' # Tidying - +} +\section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 columns \code{terms}, \code{value} and \code{id}: @@ -81,6 +80,7 @@ columns \code{terms}, \code{value} and \code{id}: \item{id}{character, id of this step} } } + \section{Case weights}{ diff --git a/man/step_normalize.Rd b/man/step_normalize.Rd index 40d2c3842..d9fc9de2e 100644 --- a/man/step_normalize.Rd +++ b/man/step_normalize.Rd @@ -71,7 +71,7 @@ columns \code{terms}, \code{statistic}, \code{value} and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} \item{statistic}{character, name of statistic, mean or sd} -\item{value}{integer, value statistic} +\item{value}{numeric, value statistic} \item{id}{character, id of this step} } } diff --git a/man/step_scale.Rd b/man/step_scale.Rd index 7b926a92a..c19180c18 100644 --- a/man/step_scale.Rd +++ b/man/step_scale.Rd @@ -65,10 +65,9 @@ the variable standard deviations from the data used in the \code{training} argument of \code{prep.recipe}. \code{bake.recipe} then applies the scaling to new data sets using these standard deviations. - -#' # Tidying - -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +} +\section{Tidying}{ +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 columns \code{terms}, \code{value}, and \code{id}: \describe{ @@ -77,6 +76,7 @@ columns \code{terms}, \code{value}, and \code{id}: \item{id}{character, id of this step} } } + \section{Case weights}{ From a0e9d39224265aef985174d774327526ddb88d0f Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Wed, 4 Oct 2023 12:38:07 -0700 Subject: [PATCH 05/12] add missing is --- R/BoxCox.R | 2 +- R/YeoJohnson.R | 2 +- R/arrange.R | 2 +- R/bin2factor.R | 2 +- R/bs.R | 2 +- R/center.R | 2 +- R/classdist.R | 2 +- R/classdist_shrunken.R | 2 +- R/corr.R | 2 +- R/count.R | 2 +- R/cut.R | 2 +- R/date.R | 2 +- R/depth.R | 2 +- R/discretize.R | 2 +- R/dummy.R | 2 +- R/dummy_extract.R | 2 +- R/dummy_multi_choice.R | 2 +- R/factor2string.R | 2 +- R/filter.R | 2 +- R/filter_missing.R | 2 +- R/geodist.R | 2 +- R/harmonic.R | 2 +- R/holiday.R | 2 +- R/hyperbolic.R | 2 +- R/ica.R | 2 +- R/impute_bag.R | 2 +- R/impute_knn.R | 2 +- R/impute_linear.R | 2 +- R/impute_lower.R | 2 +- R/impute_mean.R | 2 +- R/impute_median.R | 2 +- R/impute_mode.R | 2 +- R/impute_roll.R | 2 +- R/indicate_na.R | 2 +- R/integer.R | 2 +- R/interact.R | 2 +- R/intercept.R | 2 +- R/inverse.R | 2 +- R/invlogit.R | 2 +- R/isomap.R | 2 +- R/kpca.R | 2 +- R/kpca_poly.R | 2 +- R/kpca_rbf.R | 2 +- R/lag.R | 2 +- R/lincomb.R | 2 +- R/log.R | 2 +- R/logit.R | 2 +- R/mutate.R | 2 +- R/mutate_at.R | 2 +- R/naomit.R | 2 +- R/nnmf.R | 2 +- R/nnmf_sparse.R | 2 +- R/normalize.R | 2 +- R/novel.R | 2 +- R/ns.R | 2 +- R/num2factor.R | 2 +- R/nzv.R | 2 +- R/ordinalscore.R | 2 +- R/other.R | 2 +- R/percentile.R | 2 +- R/pls.R | 2 +- R/poly.R | 2 +- R/poly_bernstein.R | 2 +- R/profile.R | 2 +- R/range.R | 2 +- R/ratio.R | 2 +- R/regex.R | 2 +- R/relevel.R | 2 +- R/relu.R | 2 +- R/rename.R | 2 +- R/rename_at.R | 2 +- R/rm.R | 2 +- R/sample.R | 2 +- R/scale.R | 2 +- R/select.R | 2 +- R/shuffle.R | 2 +- R/slice.R | 2 +- R/spatialsign.R | 2 +- R/spline_b.R | 2 +- R/spline_convex.R | 2 +- R/spline_monotone.R | 2 +- R/spline_natural.R | 2 +- R/spline_nonnegative.R | 2 +- R/sqrt.R | 2 +- R/string2factor.R | 2 +- R/time.R | 2 +- R/unknown.R | 2 +- R/unorder.R | 2 +- R/window.R | 2 +- R/zv.R | 2 +- man/step_BoxCox.Rd | 2 +- man/step_YeoJohnson.Rd | 2 +- man/step_arrange.Rd | 2 +- man/step_bin2factor.Rd | 2 +- man/step_bs.Rd | 2 +- man/step_center.Rd | 2 +- man/step_classdist.Rd | 2 +- man/step_classdist_shrunken.Rd | 2 +- man/step_corr.Rd | 2 +- man/step_count.Rd | 2 +- man/step_cut.Rd | 2 +- man/step_date.Rd | 2 +- man/step_depth.Rd | 2 +- man/step_discretize.Rd | 2 +- man/step_dummy.Rd | 2 +- man/step_dummy_extract.Rd | 2 +- man/step_dummy_multi_choice.Rd | 2 +- man/step_factor2string.Rd | 2 +- man/step_filter.Rd | 2 +- man/step_filter_missing.Rd | 2 +- man/step_geodist.Rd | 2 +- man/step_harmonic.Rd | 2 +- man/step_holiday.Rd | 2 +- man/step_hyperbolic.Rd | 2 +- man/step_ica.Rd | 2 +- man/step_impute_bag.Rd | 2 +- man/step_impute_knn.Rd | 2 +- man/step_impute_linear.Rd | 2 +- man/step_impute_lower.Rd | 2 +- man/step_impute_mean.Rd | 2 +- man/step_impute_median.Rd | 2 +- man/step_impute_mode.Rd | 2 +- man/step_impute_roll.Rd | 2 +- man/step_indicate_na.Rd | 2 +- man/step_integer.Rd | 2 +- man/step_interact.Rd | 2 +- man/step_intercept.Rd | 2 +- man/step_inverse.Rd | 2 +- man/step_invlogit.Rd | 2 +- man/step_isomap.Rd | 2 +- man/step_kpca.Rd | 2 +- man/step_kpca_poly.Rd | 2 +- man/step_kpca_rbf.Rd | 2 +- man/step_lag.Rd | 2 +- man/step_lincomb.Rd | 2 +- man/step_log.Rd | 2 +- man/step_logit.Rd | 2 +- man/step_mutate.Rd | 2 +- man/step_mutate_at.Rd | 2 +- man/step_naomit.Rd | 2 +- man/step_nnmf.Rd | 2 +- man/step_nnmf_sparse.Rd | 2 +- man/step_normalize.Rd | 2 +- man/step_novel.Rd | 2 +- man/step_ns.Rd | 2 +- man/step_num2factor.Rd | 2 +- man/step_nzv.Rd | 2 +- man/step_ordinalscore.Rd | 2 +- man/step_other.Rd | 2 +- man/step_percentile.Rd | 2 +- man/step_pls.Rd | 2 +- man/step_poly.Rd | 2 +- man/step_poly_bernstein.Rd | 2 +- man/step_profile.Rd | 2 +- man/step_range.Rd | 2 +- man/step_ratio.Rd | 2 +- man/step_regex.Rd | 2 +- man/step_relevel.Rd | 2 +- man/step_relu.Rd | 2 +- man/step_rename.Rd | 2 +- man/step_rename_at.Rd | 2 +- man/step_rm.Rd | 2 +- man/step_sample.Rd | 2 +- man/step_scale.Rd | 2 +- man/step_select.Rd | 2 +- man/step_shuffle.Rd | 2 +- man/step_slice.Rd | 2 +- man/step_spatialsign.Rd | 2 +- man/step_spline_b.Rd | 2 +- man/step_spline_convex.Rd | 2 +- man/step_spline_monotone.Rd | 2 +- man/step_spline_natural.Rd | 2 +- man/step_spline_nonnegative.Rd | 2 +- man/step_sqrt.Rd | 2 +- man/step_string2factor.Rd | 2 +- man/step_time.Rd | 2 +- man/step_unknown.Rd | 2 +- man/step_unorder.Rd | 2 +- man/step_window.Rd | 2 +- man/step_zv.Rd | 2 +- 180 files changed, 180 insertions(+), 180 deletions(-) diff --git a/R/BoxCox.R b/R/BoxCox.R index fcd024e88..6e767b7d1 100644 --- a/R/BoxCox.R +++ b/R/BoxCox.R @@ -33,7 +33,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/YeoJohnson.R b/R/YeoJohnson.R index 9e129fab5..3445037fa 100644 --- a/R/YeoJohnson.R +++ b/R/YeoJohnson.R @@ -32,7 +32,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/arrange.R b/R/arrange.R index 07b9bdb0f..2c7e3a69e 100644 --- a/R/arrange.R +++ b/R/arrange.R @@ -17,7 +17,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/bin2factor.R b/R/bin2factor.R index 9abfbd445..360d05570 100644 --- a/R/bin2factor.R +++ b/R/bin2factor.R @@ -21,7 +21,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/bs.R b/R/bs.R index 5b4bab2e3..cef7b1c47 100644 --- a/R/bs.R +++ b/R/bs.R @@ -27,7 +27,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/center.R b/R/center.R index 48f42cc50..5871c8022 100644 --- a/R/center.R +++ b/R/center.R @@ -34,7 +34,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/classdist.R b/R/classdist.R index bb3f24976..8f2b26c63 100644 --- a/R/classdist.R +++ b/R/classdist.R @@ -42,7 +42,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `value`, `class` and `id`: #' #' \describe{ diff --git a/R/classdist_shrunken.R b/R/classdist_shrunken.R index 52ab709a6..72cf691a5 100644 --- a/R/classdist_shrunken.R +++ b/R/classdist_shrunken.R @@ -40,7 +40,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 6 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 6 #' columns `terms`, `value`, `class`, `type`, `threshold` and `id`: #' #' \describe{ diff --git a/R/corr.R b/R/corr.R index f844231d2..6ce0720cc 100644 --- a/R/corr.R +++ b/R/corr.R @@ -39,7 +39,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/count.R b/R/count.R index e1c41f97e..995856d7d 100644 --- a/R/count.R +++ b/R/count.R @@ -26,7 +26,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `result` and `id`: #' #' \describe{ diff --git a/R/cut.R b/R/cut.R index 052b4893c..c40636726 100644 --- a/R/cut.R +++ b/R/cut.R @@ -21,7 +21,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/date.R b/R/date.R index ec04fd636..e58e3ab00 100644 --- a/R/date.R +++ b/R/date.R @@ -50,7 +50,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `value`, `ordinal` and `id`: #' #' \describe{ diff --git a/R/depth.R b/R/depth.R index b126d919d..65dff8a97 100644 --- a/R/depth.R +++ b/R/depth.R @@ -53,7 +53,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `class` and `id`: #' #' \describe{ diff --git a/R/discretize.R b/R/discretize.R index a33d99a9d..62c1f9be4 100644 --- a/R/discretize.R +++ b/R/discretize.R @@ -259,7 +259,7 @@ print.discretize <- #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/dummy.R b/R/dummy.R index 40807703e..eb24e5bce 100644 --- a/R/dummy.R +++ b/R/dummy.R @@ -67,7 +67,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `columns` and `id`: #' #' \describe{ diff --git a/R/dummy_extract.R b/R/dummy_extract.R index ead395781..4296ea2e1 100644 --- a/R/dummy_extract.R +++ b/R/dummy_extract.R @@ -33,7 +33,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `columns` and `id`: #' #' \describe{ diff --git a/R/dummy_multi_choice.R b/R/dummy_multi_choice.R index b83d12f95..cb2d3c99a 100644 --- a/R/dummy_multi_choice.R +++ b/R/dummy_multi_choice.R @@ -31,7 +31,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `columns` and `id`: #' #' \describe{ diff --git a/R/factor2string.R b/R/factor2string.R index 1d2d9adda..73df55820 100644 --- a/R/factor2string.R +++ b/R/factor2string.R @@ -15,7 +15,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/filter.R b/R/filter.R index 8c9a1ac68..52cc089f3 100644 --- a/R/filter.R +++ b/R/filter.R @@ -19,7 +19,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/filter_missing.R b/R/filter_missing.R index 4984f1e58..799c49563 100644 --- a/R/filter_missing.R +++ b/R/filter_missing.R @@ -22,7 +22,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/geodist.R b/R/geodist.R index 685ba0637..5b7b18281 100644 --- a/R/geodist.R +++ b/R/geodist.R @@ -28,7 +28,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 7 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 7 #' columns `latitude`, `longitude`, `ref_latitude`, `ref_longitude`, #' `is_lat_lon`, `name` and `id`: #' diff --git a/R/harmonic.R b/R/harmonic.R index e069b3b1a..09e351150 100644 --- a/R/harmonic.R +++ b/R/harmonic.R @@ -66,7 +66,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 6 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 6 #' columns `terms`, `starting_val`, `cycle_size`, `frequency`, `key`, and `id`: #' #' \describe{ diff --git a/R/holiday.R b/R/holiday.R index 0f6af7581..99d5ddc3d 100644 --- a/R/holiday.R +++ b/R/holiday.R @@ -19,7 +19,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `holiday` and `id`: #' #' \describe{ diff --git a/R/hyperbolic.R b/R/hyperbolic.R index e57497b40..35e0dabc1 100644 --- a/R/hyperbolic.R +++ b/R/hyperbolic.R @@ -15,7 +15,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `inverse`, `func` and `id`: #' #' \describe{ diff --git a/R/ica.R b/R/ica.R index 2db94e090..120a1e730 100644 --- a/R/ica.R +++ b/R/ica.R @@ -41,7 +41,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `component`, `value` and `id`: #' #' \describe{ diff --git a/R/impute_bag.R b/R/impute_bag.R index 4a8111fab..cabba7d50 100644 --- a/R/impute_bag.R +++ b/R/impute_bag.R @@ -49,7 +49,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `model` and `id`: #' #' \describe{ diff --git a/R/impute_knn.R b/R/impute_knn.R index 2b150c56d..dae25aac5 100644 --- a/R/impute_knn.R +++ b/R/impute_knn.R @@ -34,7 +34,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `predictors`, `neighbors` and `id`: #' #' \describe{ diff --git a/R/impute_linear.R b/R/impute_linear.R index 444bb925e..806d7521e 100644 --- a/R/impute_linear.R +++ b/R/impute_linear.R @@ -28,7 +28,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `model` and `id`: #' #' \describe{ diff --git a/R/impute_lower.R b/R/impute_lower.R index 95cb341a9..2b701ed58 100644 --- a/R/impute_lower.R +++ b/R/impute_lower.R @@ -22,7 +22,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/impute_mean.R b/R/impute_mean.R index 8569db706..2d7f51456 100644 --- a/R/impute_mean.R +++ b/R/impute_mean.R @@ -23,7 +23,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `model` and `id`: #' #' \describe{ diff --git a/R/impute_median.R b/R/impute_median.R index 7cbb4c8ce..f724d3e5a 100644 --- a/R/impute_median.R +++ b/R/impute_median.R @@ -20,7 +20,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `model` and `id`: #' #' \describe{ diff --git a/R/impute_mode.R b/R/impute_mode.R index 1d4c790de..d1c4611d1 100644 --- a/R/impute_mode.R +++ b/R/impute_mode.R @@ -23,7 +23,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/impute_roll.R b/R/impute_roll.R index 7f64cf967..071685d7a 100644 --- a/R/impute_roll.R +++ b/R/impute_roll.R @@ -39,7 +39,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `window` and `id`: #' #' \describe{ diff --git a/R/indicate_na.R b/R/indicate_na.R index 06834b968..794096d71 100644 --- a/R/indicate_na.R +++ b/R/indicate_na.R @@ -13,7 +13,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/integer.R b/R/integer.R index bd7f73c0e..b174b6d34 100644 --- a/R/integer.R +++ b/R/integer.R @@ -31,7 +31,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/interact.R b/R/interact.R index c2a4c5969..03784c3bb 100644 --- a/R/interact.R +++ b/R/interact.R @@ -50,7 +50,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/intercept.R b/R/intercept.R index 0690cf2eb..d11262063 100644 --- a/R/intercept.R +++ b/R/intercept.R @@ -22,7 +22,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/inverse.R b/R/inverse.R index 0eaf15b43..4aa2ffddc 100644 --- a/R/inverse.R +++ b/R/inverse.R @@ -14,7 +14,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/invlogit.R b/R/invlogit.R index a8ab44978..27e1b4ca5 100644 --- a/R/invlogit.R +++ b/R/invlogit.R @@ -14,7 +14,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/isomap.R b/R/isomap.R index c451d8976..fc00ac530 100644 --- a/R/isomap.R +++ b/R/isomap.R @@ -45,7 +45,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/kpca.R b/R/kpca.R index f5ae5312b..ffb166e22 100644 --- a/R/kpca.R +++ b/R/kpca.R @@ -30,7 +30,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/kpca_poly.R b/R/kpca_poly.R index 8a1d5972b..c3aa33635 100644 --- a/R/kpca_poly.R +++ b/R/kpca_poly.R @@ -25,7 +25,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/kpca_rbf.R b/R/kpca_rbf.R index 2d4d84198..c3339554a 100644 --- a/R/kpca_rbf.R +++ b/R/kpca_rbf.R @@ -25,7 +25,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/lag.R b/R/lag.R index 933ba273c..262555a14 100644 --- a/R/lag.R +++ b/R/lag.R @@ -18,7 +18,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/lincomb.R b/R/lincomb.R index 36ab48294..90d570cca 100644 --- a/R/lincomb.R +++ b/R/lincomb.R @@ -22,7 +22,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/log.R b/R/log.R index 85f90c969..de5eb7bda 100644 --- a/R/log.R +++ b/R/log.R @@ -18,7 +18,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `base` and `id`: #' #' \describe{ diff --git a/R/logit.R b/R/logit.R index 706dc19bd..b596923dd 100644 --- a/R/logit.R +++ b/R/logit.R @@ -16,7 +16,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/mutate.R b/R/mutate.R index 18b469e56..b9e978a20 100644 --- a/R/mutate.R +++ b/R/mutate.R @@ -20,7 +20,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/mutate_at.R b/R/mutate_at.R index e0db3dcee..add0a9f96 100644 --- a/R/mutate_at.R +++ b/R/mutate_at.R @@ -16,7 +16,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/naomit.R b/R/naomit.R index 366245cc6..c69da9846 100644 --- a/R/naomit.R +++ b/R/naomit.R @@ -14,7 +14,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/nnmf.R b/R/nnmf.R index 85d5d071e..5baba637e 100644 --- a/R/nnmf.R +++ b/R/nnmf.R @@ -39,7 +39,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `value`, `component` and `id`: #' #' \describe{ diff --git a/R/nnmf_sparse.R b/R/nnmf_sparse.R index e395694d6..2f3645223 100644 --- a/R/nnmf_sparse.R +++ b/R/nnmf_sparse.R @@ -31,7 +31,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `value`, `component` and `id`: #' #' \describe{ diff --git a/R/normalize.R b/R/normalize.R index e2d95136f..9c43cb64e 100644 --- a/R/normalize.R +++ b/R/normalize.R @@ -23,7 +23,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `statistic`, `value` and `id`: #' #' \describe{ diff --git a/R/novel.R b/R/novel.R index 439661960..089a42c6b 100644 --- a/R/novel.R +++ b/R/novel.R @@ -33,7 +33,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/ns.R b/R/ns.R index 204d46251..939e1e873 100644 --- a/R/ns.R +++ b/R/ns.R @@ -26,7 +26,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/num2factor.R b/R/num2factor.R index 8bd298824..9404ce0e8 100644 --- a/R/num2factor.R +++ b/R/num2factor.R @@ -19,7 +19,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `ordered` and `id`: #' #' \describe{ diff --git a/R/nzv.R b/R/nzv.R index e5aa2040a..3c100da17 100644 --- a/R/nzv.R +++ b/R/nzv.R @@ -42,7 +42,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/ordinalscore.R b/R/ordinalscore.R index 46809102a..85ceea399 100644 --- a/R/ordinalscore.R +++ b/R/ordinalscore.R @@ -20,7 +20,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/other.R b/R/other.R index 1eecd292a..20f11c8be 100644 --- a/R/other.R +++ b/R/other.R @@ -43,7 +43,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `retained` and `id`: #' #' \describe{ diff --git a/R/percentile.R b/R/percentile.R index a1cf7ec83..32d93bd6a 100644 --- a/R/percentile.R +++ b/R/percentile.R @@ -24,7 +24,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `value`, `percentile` and `id`: #' #' \describe{ diff --git a/R/pls.R b/R/pls.R index 540421c6a..06caa0825 100644 --- a/R/pls.R +++ b/R/pls.R @@ -41,7 +41,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `value`, `component` and `id`: #' #' \describe{ diff --git a/R/poly.R b/R/poly.R index f71eaa0dc..75a09eb51 100644 --- a/R/poly.R +++ b/R/poly.R @@ -31,7 +31,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `degree` and `id`: #' #' \describe{ diff --git a/R/poly_bernstein.R b/R/poly_bernstein.R index 4063c57b2..e02313a5d 100644 --- a/R/poly_bernstein.R +++ b/R/poly_bernstein.R @@ -23,7 +23,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/profile.R b/R/profile.R index 2b2a93be3..36069472c 100644 --- a/R/profile.R +++ b/R/profile.R @@ -38,7 +38,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `type` and `id`: #' #' \describe{ diff --git a/R/range.R b/R/range.R index b51fbf424..4de6c5407 100644 --- a/R/range.R +++ b/R/range.R @@ -24,7 +24,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `min`, `max` and `id`: #' #' \describe{ diff --git a/R/ratio.R b/R/ratio.R index d9ab780d1..deae0275f 100644 --- a/R/ratio.R +++ b/R/ratio.R @@ -29,7 +29,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `denom` and `id`: #' #' \describe{ diff --git a/R/regex.R b/R/regex.R index 5445c1a23..b099b03cd 100644 --- a/R/regex.R +++ b/R/regex.R @@ -24,7 +24,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `result` and `id`: #' #' \describe{ diff --git a/R/relevel.R b/R/relevel.R index 6f4c124f0..aa8739269 100644 --- a/R/relevel.R +++ b/R/relevel.R @@ -24,7 +24,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/relu.R b/R/relu.R index 30254a9ad..144a4a774 100644 --- a/R/relu.R +++ b/R/relu.R @@ -41,7 +41,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `shift`, `reverse` and `id`: #' #' \describe{ diff --git a/R/rename.R b/R/rename.R index f96f3d1b9..7c6758151 100644 --- a/R/rename.R +++ b/R/rename.R @@ -16,7 +16,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/rename_at.R b/R/rename_at.R index ffacfca01..b242dece1 100644 --- a/R/rename_at.R +++ b/R/rename_at.R @@ -15,7 +15,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/rm.R b/R/rm.R index 047867263..a2dd40926 100644 --- a/R/rm.R +++ b/R/rm.R @@ -13,7 +13,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/sample.R b/R/sample.R index 830e5ca6d..e84969f50 100644 --- a/R/sample.R +++ b/R/sample.R @@ -18,7 +18,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `size`, `replace` and `id`: #' #' \describe{ diff --git a/R/scale.R b/R/scale.R index 1c201ffe9..ce21695b3 100644 --- a/R/scale.R +++ b/R/scale.R @@ -25,7 +25,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value`, and `id`: #' #' \describe{ diff --git a/R/select.R b/R/select.R index 8aa5cdc1c..44638109c 100644 --- a/R/select.R +++ b/R/select.R @@ -15,7 +15,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/shuffle.R b/R/shuffle.R index 35ad1b700..13402204b 100644 --- a/R/shuffle.R +++ b/R/shuffle.R @@ -10,7 +10,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/slice.R b/R/slice.R index f995d9522..da526524a 100644 --- a/R/slice.R +++ b/R/slice.R @@ -17,7 +17,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/spatialsign.R b/R/spatialsign.R index 73b59c9ee..941ad6671 100644 --- a/R/spatialsign.R +++ b/R/spatialsign.R @@ -20,7 +20,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/spline_b.R b/R/spline_b.R index 88a02e9e1..163923e90 100644 --- a/R/spline_b.R +++ b/R/spline_b.R @@ -37,7 +37,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/spline_convex.R b/R/spline_convex.R index 6a7f2a2c8..95b7d2c85 100644 --- a/R/spline_convex.R +++ b/R/spline_convex.R @@ -28,7 +28,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/spline_monotone.R b/R/spline_monotone.R index a39e01f0d..0d9a316b6 100644 --- a/R/spline_monotone.R +++ b/R/spline_monotone.R @@ -29,7 +29,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/spline_natural.R b/R/spline_natural.R index 5112926a0..10bb42cc4 100644 --- a/R/spline_natural.R +++ b/R/spline_natural.R @@ -27,7 +27,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/spline_nonnegative.R b/R/spline_nonnegative.R index 690bc6be3..bcc804f89 100644 --- a/R/spline_nonnegative.R +++ b/R/spline_nonnegative.R @@ -32,7 +32,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/sqrt.R b/R/sqrt.R index 9edda6086..a04b50a80 100644 --- a/R/sqrt.R +++ b/R/sqrt.R @@ -11,7 +11,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/string2factor.R b/R/string2factor.R index fd51cd4a8..c99a980c1 100644 --- a/R/string2factor.R +++ b/R/string2factor.R @@ -46,7 +46,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `ordered` and `id`: #' #' \describe{ diff --git a/R/time.R b/R/time.R index 3aca88a71..8ac49bea9 100644 --- a/R/time.R +++ b/R/time.R @@ -30,7 +30,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/unknown.R b/R/unknown.R index 9808fe48b..dca5cc144 100644 --- a/R/unknown.R +++ b/R/unknown.R @@ -24,7 +24,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 #' columns `terms`, `value` and `id`: #' #' \describe{ diff --git a/R/unorder.R b/R/unorder.R index 38ab47ad5..716a6727c 100644 --- a/R/unorder.R +++ b/R/unorder.R @@ -12,7 +12,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/window.R b/R/window.R index 9029a1a1e..f6522bd6e 100644 --- a/R/window.R +++ b/R/window.R @@ -44,7 +44,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 #' columns `terms`, `statistic`, `size` and `id`: #' #' \describe{ diff --git a/R/zv.R b/R/zv.R index eb5c4c5e9..5f93e163f 100644 --- a/R/zv.R +++ b/R/zv.R @@ -18,7 +18,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 #' columns `terms` and `id`: #' #' \describe{ diff --git a/man/step_BoxCox.Rd b/man/step_BoxCox.Rd index fde943eca..3f281545b 100644 --- a/man/step_BoxCox.Rd +++ b/man/step_BoxCox.Rd @@ -75,7 +75,7 @@ closed to the bounds, or if the optimization fails, a value of \code{NA} is used and no transformation is applied. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_YeoJohnson.Rd b/man/step_YeoJohnson.Rd index 568a58b24..78d1bba12 100644 --- a/man/step_YeoJohnson.Rd +++ b/man/step_YeoJohnson.Rd @@ -78,7 +78,7 @@ closed to the bounds, or if the optimization fails, a value of \code{NA} is used and no transformation is applied. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_arrange.Rd b/man/step_arrange.Rd index eddf5a09f..4977422b5 100644 --- a/man/step_arrange.Rd +++ b/man/step_arrange.Rd @@ -55,7 +55,7 @@ to embed the value of the object in the expression (to be portable between sessions). See the examples. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_bin2factor.Rd b/man/step_bin2factor.Rd index 97aea3fd2..2507cc179 100644 --- a/man/step_bin2factor.Rd +++ b/man/step_bin2factor.Rd @@ -66,7 +66,7 @@ density of numeric binary data. Note that the numeric data is only verified to be numeric (and does not count levels). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_bs.Rd b/man/step_bs.Rd index 4bddb7655..5fe6dfa75 100644 --- a/man/step_bs.Rd +++ b/man/step_bs.Rd @@ -75,7 +75,7 @@ from the data and new columns are added. The naming convention for the new variables is \code{varname_bs_1} and so on. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_center.Rd b/man/step_center.Rd index b37204242..f764662d6 100644 --- a/man/step_center.Rd +++ b/man/step_center.Rd @@ -59,7 +59,7 @@ argument of \code{prep.recipe}. \code{bake.recipe} then applies the centering to new data sets using these means. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_classdist.Rd b/man/step_classdist.Rd index 4a97518fb..e84724582 100644 --- a/man/step_classdist.Rd +++ b/man/step_classdist.Rd @@ -98,7 +98,7 @@ there must be at least as many data points are variables overall. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{value}, \code{class} and \code{id}: \describe{ diff --git a/man/step_classdist_shrunken.Rd b/man/step_classdist_shrunken.Rd index 3d70bc140..51628e63e 100644 --- a/man/step_classdist_shrunken.Rd +++ b/man/step_classdist_shrunken.Rd @@ -97,7 +97,7 @@ values and, by default, have the prefix \code{classdist_}. The naming format can be changed using the \code{prefix} argument. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 6 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 6 columns \code{terms}, \code{value}, \code{class}, \code{type}, \code{threshold} and \code{id}: \describe{ diff --git a/man/step_corr.Rd b/man/step_corr.Rd index a68a18e6a..61e6f1849 100644 --- a/man/step_corr.Rd +++ b/man/step_corr.Rd @@ -82,7 +82,7 @@ The arguments \code{use} and \code{method} don't take effect if case weights are used in the recipe. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_count.Rd b/man/step_count.Rd index 588aae54f..a89f7c229 100644 --- a/man/step_count.Rd +++ b/man/step_count.Rd @@ -73,7 +73,7 @@ sequence of any existing operations. variable that counts instances of a regular expression pattern in text. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{result} and \code{id}: \describe{ diff --git a/man/step_cut.Rd b/man/step_cut.Rd index 5f658f053..1badf58ac 100644 --- a/man/step_cut.Rd +++ b/man/step_cut.Rd @@ -61,7 +61,7 @@ points will end up in the last. \code{include.lowest} set to \code{TRUE}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_date.Rd b/man/step_date.Rd index abbb20abe..f0888411c 100644 --- a/man/step_date.Rd +++ b/man/step_date.Rd @@ -97,7 +97,7 @@ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns \code{terms} (the selectors or variables selected), \code{value} (the feature names), and \code{ordinal} (a logical) is returned. -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{value}, \code{ordinal} and \code{id}: \describe{ diff --git a/man/step_depth.Rd b/man/step_depth.Rd index 5730eb3b7..0b2896d0b 100644 --- a/man/step_depth.Rd +++ b/man/step_depth.Rd @@ -105,7 +105,7 @@ replace the original values and by default have the prefix \code{depth_}. The naming format can be changed using the \code{prefix} argument. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{class} and \code{id}: \describe{ diff --git a/man/step_discretize.Rd b/man/step_discretize.Rd index f637291c8..a0d692394 100644 --- a/man/step_discretize.Rd +++ b/man/step_discretize.Rd @@ -67,7 +67,7 @@ convert numeric data into a factor with bins having approximately the same number of data points (based on a training set). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_dummy.Rd b/man/step_dummy.Rd index d70fdbfeb..b2ba6e836 100644 --- a/man/step_dummy.Rd +++ b/man/step_dummy.Rd @@ -113,7 +113,7 @@ The \href{https://recipes.tidymodels.org/articles/Dummies.html}{package vignette and interactions has more information. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{columns} and \code{id}: \describe{ diff --git a/man/step_dummy_extract.Rd b/man/step_dummy_extract.Rd index 04f2aefdb..83d6c5e5c 100644 --- a/man/step_dummy_extract.Rd +++ b/man/step_dummy_extract.Rd @@ -97,7 +97,7 @@ the \code{naming} argument; the function \code{\link[=dummy_names]{dummy_names() default. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{columns} and \code{id}: \describe{ diff --git a/man/step_dummy_multi_choice.Rd b/man/step_dummy_multi_choice.Rd index 61562d027..acb0e8272 100644 --- a/man/step_dummy_multi_choice.Rd +++ b/man/step_dummy_multi_choice.Rd @@ -99,7 +99,7 @@ This step has 1 tuning parameters: } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{columns} and \code{id}: \describe{ diff --git a/man/step_factor2string.Rd b/man/step_factor2string.Rd index bca2a675c..6a490928a 100644 --- a/man/step_factor2string.Rd +++ b/man/step_factor2string.Rd @@ -54,7 +54,7 @@ this step will be converted to factors after all of the steps have been prepped. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_filter.Rd b/man/step_filter.Rd index e4b587181..6343612bb 100644 --- a/man/step_filter.Rd +++ b/man/step_filter.Rd @@ -67,7 +67,7 @@ before starting a preprocessing \code{\link[=recipe]{recipe()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_filter_missing.Rd b/man/step_filter_missing.Rd index 1747ec241..71ebb4469 100644 --- a/man/step_filter_missing.Rd +++ b/man/step_filter_missing.Rd @@ -65,7 +65,7 @@ values exceeds the \code{threshold}. All variables with missing values will be removed for \code{threshold = 0}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_geodist.Rd b/man/step_geodist.Rd index 676462b41..dc3abd860 100644 --- a/man/step_geodist.Rd +++ b/man/step_geodist.Rd @@ -79,7 +79,7 @@ distances if \code{is_lat_lon} is FALSE. If \code{is_lat_lon} is TRUE, the Haver formula is used to calculate the great-circle distance in meters. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 7 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 7 columns \code{latitude}, \code{longitude}, \code{ref_latitude}, \code{ref_longitude}, \code{is_lat_lon}, \code{name} and \code{id}: diff --git a/man/step_harmonic.Rd b/man/step_harmonic.Rd index 8eeb21055..062fb1957 100644 --- a/man/step_harmonic.Rd +++ b/man/step_harmonic.Rd @@ -113,7 +113,7 @@ This step has 1 tuning parameters: } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 6 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 6 columns \code{terms}, \code{starting_val}, \code{cycle_size}, \code{frequency}, \code{key}, and \code{id}: \describe{ diff --git a/man/step_holiday.Rd b/man/step_holiday.Rd index 07a90aca0..16312bb56 100644 --- a/man/step_holiday.Rd +++ b/man/step_holiday.Rd @@ -64,7 +64,7 @@ remove the original date variables by default. Set \code{keep_original_cols} to \code{FALSE} to remove them. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{holiday} and \code{id}: \describe{ diff --git a/man/step_hyperbolic.Rd b/man/step_hyperbolic.Rd index 88a5930c8..f74190c88 100644 --- a/man/step_hyperbolic.Rd +++ b/man/step_hyperbolic.Rd @@ -55,7 +55,7 @@ sequence of any existing operations. transform data using a hyperbolic function. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{inverse}, \code{func} and \code{id}: \describe{ diff --git a/man/step_ica.Rd b/man/step_ica.Rd index 536d88982..97674bef0 100644 --- a/man/step_ica.Rd +++ b/man/step_ica.Rd @@ -103,7 +103,7 @@ sequence of numbers. The variable names are padded with zeros. For example, if the names would be \code{IC1} - \code{IC101}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{component}, \code{value} and \code{id}: \describe{ diff --git a/man/step_impute_bag.Rd b/man/step_impute_bag.Rd index 48a94f5c9..cc0a6c565 100644 --- a/man/step_impute_bag.Rd +++ b/man/step_impute_bag.Rd @@ -109,7 +109,7 @@ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns \code{terms} (the selectors or variables selected) and \code{model} (the bagged tree object) is returned. -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{model} and \code{id}: \describe{ diff --git a/man/step_impute_knn.Rd b/man/step_impute_knn.Rd index 980bb88cf..73129508a 100644 --- a/man/step_impute_knn.Rd +++ b/man/step_impute_knn.Rd @@ -102,7 +102,7 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_knnimput to \code{step_impute_knn()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{predictors}, \code{neighbors} and \code{id}: \describe{ diff --git a/man/step_impute_linear.Rd b/man/step_impute_linear.Rd index b80b363dd..fb22496c7 100644 --- a/man/step_impute_linear.Rd +++ b/man/step_impute_linear.Rd @@ -70,7 +70,7 @@ Since this is a linear regression, the imputation model only uses complete cases for the training set predictors. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{model} and \code{id}: \describe{ diff --git a/man/step_impute_lower.Rd b/man/step_impute_lower.Rd index f3eddab9e..f9aee8a6a 100644 --- a/man/step_impute_lower.Rd +++ b/man/step_impute_lower.Rd @@ -71,7 +71,7 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_lowerimp to \code{step_impute_lower()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_impute_mean.Rd b/man/step_impute_mean.Rd index 288e45540..7ca72b9e6 100644 --- a/man/step_impute_mean.Rd +++ b/man/step_impute_mean.Rd @@ -75,7 +75,7 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_meanimpu to \code{step_impute_mean()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{model} and \code{id}: \describe{ diff --git a/man/step_impute_median.Rd b/man/step_impute_median.Rd index 95afed9f5..99aac9760 100644 --- a/man/step_impute_median.Rd +++ b/man/step_impute_median.Rd @@ -69,7 +69,7 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_medianimpute()} to \code{step_impute_median()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{model} and \code{id}: \describe{ diff --git a/man/step_impute_mode.Rd b/man/step_impute_mode.Rd index dcb2587a5..a169c8f3f 100644 --- a/man/step_impute_mode.Rd +++ b/man/step_impute_mode.Rd @@ -75,7 +75,7 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_modeimpu to \code{step_impute_mode()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_impute_roll.Rd b/man/step_impute_roll.Rd index e3a6386a7..e2ff3216a 100644 --- a/man/step_impute_roll.Rd +++ b/man/step_impute_roll.Rd @@ -92,7 +92,7 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_rollimpu to \code{step_impute_roll()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{window} and \code{id}: \describe{ diff --git a/man/step_indicate_na.Rd b/man/step_indicate_na.Rd index 87a7bb4f2..69fa4ae86 100644 --- a/man/step_indicate_na.Rd +++ b/man/step_indicate_na.Rd @@ -58,7 +58,7 @@ create and append additional binary columns to the data set to indicate which observations are missing. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_integer.Rd b/man/step_integer.Rd index ab331572a..40075b469 100644 --- a/man/step_integer.Rd +++ b/man/step_integer.Rd @@ -73,7 +73,7 @@ Despite the name, the new values are returned as numeric unless \code{strict = TRUE}, which will coerce the results to integers. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_interact.Rd b/man/step_interact.Rd index 09fd387b4..a0f54ee58 100644 --- a/man/step_interact.Rd +++ b/man/step_interact.Rd @@ -93,7 +93,7 @@ so that the formula is now \code{(x_2 + x_3 + x_4 + x_5 + x_6):z} and all two-way interactions are created. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_intercept.Rd b/man/step_intercept.Rd index 24e5358ce..a9291759a 100644 --- a/man/step_intercept.Rd +++ b/man/step_intercept.Rd @@ -55,7 +55,7 @@ only called in the bake step. Be careful to avoid unintentional transformations when calling steps with \code{all_predictors()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_inverse.Rd b/man/step_inverse.Rd index c1c9b4b74..e38902a34 100644 --- a/man/step_inverse.Rd +++ b/man/step_inverse.Rd @@ -52,7 +52,7 @@ sequence of any existing operations. transform the data. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_invlogit.Rd b/man/step_invlogit.Rd index 02d3e5772..2f0aa195f 100644 --- a/man/step_invlogit.Rd +++ b/man/step_invlogit.Rd @@ -53,7 +53,7 @@ real line and translates them to be between zero and one using the function \code{f(x) = 1/(1+exp(-x))}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_isomap.Rd b/man/step_isomap.Rd index cdc4b63af..33e016e39 100644 --- a/man/step_isomap.Rd +++ b/man/step_isomap.Rd @@ -100,7 +100,7 @@ if \code{num_terms < 10}, their names will be \code{Isomap1} - \code{Isomap001} - \code{Isomap101}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_kpca.Rd b/man/step_kpca.Rd index d70cf6bf8..a3af87c57 100644 --- a/man/step_kpca.Rd +++ b/man/step_kpca.Rd @@ -111,7 +111,7 @@ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_kpca_poly.Rd b/man/step_kpca_poly.Rd index a1fcc8d01..94ff64916 100644 --- a/man/step_kpca_poly.Rd +++ b/man/step_kpca_poly.Rd @@ -113,7 +113,7 @@ This step has 4 tuning parameters: } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_kpca_rbf.Rd b/man/step_kpca_rbf.Rd index 7059930a2..54ca6c0f2 100644 --- a/man/step_kpca_rbf.Rd +++ b/man/step_kpca_rbf.Rd @@ -109,7 +109,7 @@ This step has 2 tuning parameters: } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_lag.Rd b/man/step_lag.Rd index c0a78462c..b8a71f2c8 100644 --- a/man/step_lag.Rd +++ b/man/step_lag.Rd @@ -70,7 +70,7 @@ The step assumes that the data are already \emph{in the proper sequential order} for lagging. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_lincomb.Rd b/man/step_lincomb.Rd index 3ea35f080..f5c2121b1 100644 --- a/man/step_lincomb.Rd +++ b/man/step_lincomb.Rd @@ -64,7 +64,7 @@ removed to resolve the issue. This algorithm may need to be applied multiple times (as defined by \code{max_steps}). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_log.Rd b/man/step_log.Rd index 3c8fb2cae..f1023ba16 100644 --- a/man/step_log.Rd +++ b/man/step_log.Rd @@ -60,7 +60,7 @@ sequence of any existing operations. transform data. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{base} and \code{id}: \describe{ diff --git a/man/step_logit.Rd b/man/step_logit.Rd index 5240e6f49..3b23d1c3f 100644 --- a/man/step_logit.Rd +++ b/man/step_logit.Rd @@ -57,7 +57,7 @@ zero and one and translates them to be on the real line using the function \code{f(p) = log(p/(1-p))}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_mutate.Rd b/man/step_mutate.Rd index cc14b4662..6250834f3 100644 --- a/man/step_mutate.Rd +++ b/man/step_mutate.Rd @@ -62,7 +62,7 @@ If a preceding step removes a column that is selected by name in \code{step_mutate()}, the recipe will error when being estimated with \code{\link[=prep]{prep()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_mutate_at.Rd b/man/step_mutate_at.Rd index 8118d31aa..629acb3b5 100644 --- a/man/step_mutate_at.Rd +++ b/man/step_mutate_at.Rd @@ -60,7 +60,7 @@ When applied to new data or testing data, this transformation would use the mean of \code{w} from the \emph{new} data, not the mean of \code{w} from the training data. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_naomit.Rd b/man/step_naomit.Rd index 41b0659b5..4476b0930 100644 --- a/man/step_naomit.Rd +++ b/man/step_naomit.Rd @@ -58,7 +58,7 @@ before starting a preprocessing \code{\link[=recipe]{recipe()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_nnmf.Rd b/man/step_nnmf.Rd index 4123a62f5..96f151363 100644 --- a/man/step_nnmf.Rd +++ b/man/step_nnmf.Rd @@ -99,7 +99,7 @@ sequence of numbers. The variable names are padded with zeros. For example, if the names would be \code{NNMF1} - \code{NNMF101}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{value}, \code{component} and \code{id}: \describe{ diff --git a/man/step_nnmf_sparse.Rd b/man/step_nnmf_sparse.Rd index 8882f77ce..f27b0038c 100644 --- a/man/step_nnmf_sparse.Rd +++ b/man/step_nnmf_sparse.Rd @@ -91,7 +91,7 @@ sequence of numbers. The variable names are padded with zeros. For example, if the names would be \code{NNMF1} - \code{NNMF101}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{value}, \code{component} and \code{id}: \describe{ diff --git a/man/step_normalize.Rd b/man/step_normalize.Rd index d9fc9de2e..2abb2b4a8 100644 --- a/man/step_normalize.Rd +++ b/man/step_normalize.Rd @@ -65,7 +65,7 @@ deviations and means from the data used in the \code{training} argument of these estimates. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{statistic}, \code{value} and \code{id}: \describe{ diff --git a/man/step_novel.Rd b/man/step_novel.Rd index c7dd79890..cfee7afce 100644 --- a/man/step_novel.Rd +++ b/man/step_novel.Rd @@ -72,7 +72,7 @@ When fitting a model that can deal with new factor levels, consider using new levels at prediction time, instead of throwing warnings or errors. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_ns.Rd b/man/step_ns.Rd index 77c9f1968..1d1890087 100644 --- a/man/step_ns.Rd +++ b/man/step_ns.Rd @@ -72,7 +72,7 @@ from the data and new columns are added. The naming convention for the new variables is \code{varname_ns_1} and so on. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_num2factor.Rd b/man/step_num2factor.Rd index a558b136b..e2c6385af 100644 --- a/man/step_num2factor.Rd +++ b/man/step_num2factor.Rd @@ -60,7 +60,7 @@ sequence of any existing operations. integers. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{ordered} and \code{id}: \describe{ diff --git a/man/step_nzv.Rd b/man/step_nzv.Rd index ed3e83330..42af14581 100644 --- a/man/step_nzv.Rd +++ b/man/step_nzv.Rd @@ -88,7 +88,7 @@ In the above example, the frequency ratio is 999 and the unique value percent is 0.2\%. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_ordinalscore.Rd b/man/step_ordinalscore.Rd index f282b9ad7..f65ada141 100644 --- a/man/step_ordinalscore.Rd +++ b/man/step_ordinalscore.Rd @@ -61,7 +61,7 @@ a linear scale (1, 2, 3, ... \code{C}) but custom score functions can also be used (see the example below). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_other.Rd b/man/step_other.Rd index a5a4b3421..153b63c3d 100644 --- a/man/step_other.Rd +++ b/man/step_other.Rd @@ -84,7 +84,7 @@ When data to be processed contains novel levels (i.e., not contained in the training set), the other category is assigned. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{retained} and \code{id}: \describe{ diff --git a/man/step_percentile.Rd b/man/step_percentile.Rd index 3b890ba63..2360fafd9 100644 --- a/man/step_percentile.Rd +++ b/man/step_percentile.Rd @@ -61,7 +61,7 @@ sequence of any existing operations. the value of a variable with its percentile from the training set. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{value}, \code{percentile} and \code{id}: \describe{ diff --git a/man/step_pls.Rd b/man/step_pls.Rd index d69ac9b97..82148a63c 100644 --- a/man/step_pls.Rd +++ b/man/step_pls.Rd @@ -107,7 +107,7 @@ proportion to determine the \code{keepX} parameter in \code{mixOmics::spls()} an \code{mixOmics::splsda()}. See the references in \code{mixOmics::spls()} for details. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{value}, \code{component} and \code{id}: \describe{ diff --git a/man/step_poly.Rd b/man/step_poly.Rd index 6ce3874eb..5a8a134de 100644 --- a/man/step_poly.Rd +++ b/man/step_poly.Rd @@ -75,7 +75,7 @@ otherwise be a problem for large values of \code{degree}. Orthogonal polynomial expansion pick up the same signal as their uncorrelated counterpart. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{degree} and \code{id}: \describe{ diff --git a/man/step_poly_bernstein.Rd b/man/step_poly_bernstein.Rd index ef2b5fd89..2c81ebee4 100644 --- a/man/step_poly_bernstein.Rd +++ b/man/step_poly_bernstein.Rd @@ -75,7 +75,7 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_profile.Rd b/man/step_profile.Rd index 365404d6f..dfed6b724 100644 --- a/man/step_profile.Rd +++ b/man/step_profile.Rd @@ -88,7 +88,7 @@ This step is atypical in that, when baked, the based on the fixed and profiled variable's information. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{type} and \code{id}: \describe{ diff --git a/man/step_range.Rd b/man/step_range.Rd index b5ce1f59e..ca318f091 100644 --- a/man/step_range.Rd +++ b/man/step_range.Rd @@ -68,7 +68,7 @@ the training set, the new values are truncated at \code{min} or \code{max}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{min}, \code{max} and \code{id}: \describe{ diff --git a/man/step_ratio.Rd b/man/step_ratio.Rd index e1598a0b2..df463c09c 100644 --- a/man/step_ratio.Rd +++ b/man/step_ratio.Rd @@ -76,7 +76,7 @@ one or more ratios from selected numeric variables. When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns \code{terms} (the selectors or variables selected) and \code{denom} is returned. -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{denom} and \code{id}: \describe{ diff --git a/man/step_regex.Rd b/man/step_regex.Rd index 81c94643f..33a78895d 100644 --- a/man/step_regex.Rd +++ b/man/step_regex.Rd @@ -69,7 +69,7 @@ sequence of any existing operations. new dummy variable based on a regular expression. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{result} and \code{id}: \describe{ diff --git a/man/step_relevel.Rd b/man/step_relevel.Rd index 7ff1f230a..2fbd448af 100644 --- a/man/step_relevel.Rd +++ b/man/step_relevel.Rd @@ -62,7 +62,7 @@ Note that if the original columns are character, they will be converted to factors by this step. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_relu.Rd b/man/step_relu.Rd index bf834ad11..56eefe4b5 100644 --- a/man/step_relu.Rd +++ b/man/step_relu.Rd @@ -85,7 +85,7 @@ residuals only if they are within a certain margin of the decision boundary. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{shift}, \code{reverse} and \code{id}: \describe{ diff --git a/man/step_rename.Rd b/man/step_rename.Rd index 96cde5769..feffd0065 100644 --- a/man/step_rename.Rd +++ b/man/step_rename.Rd @@ -54,7 +54,7 @@ quasiquotation (e.g. \verb{!!}) to embed the value of the object in the expression (to be portable between sessions). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_rename_at.Rd b/man/step_rename_at.Rd index 3198041f5..6ef0bafa1 100644 --- a/man/step_rename_at.Rd +++ b/man/step_rename_at.Rd @@ -54,7 +54,7 @@ rename the selected variables using a common function via \code{\link[dplyr:select_all]{dplyr::rename_at()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_rm.Rd b/man/step_rm.Rd index c6397284c..63dfa9419 100644 --- a/man/step_rm.Rd +++ b/man/step_rm.Rd @@ -55,7 +55,7 @@ specifically referenced by name. To avoid this, see the advice in the \emph{Tips for saving recipes and filtering columns} section of \link{selections}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_sample.Rd b/man/step_sample.Rd index 9f36042b5..52aeafa9f 100644 --- a/man/step_sample.Rd +++ b/man/step_sample.Rd @@ -65,7 +65,7 @@ before starting a preprocessing \code{\link[=recipe]{recipe()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{size}, \code{replace} and \code{id}: \describe{ diff --git a/man/step_scale.Rd b/man/step_scale.Rd index c19180c18..979b276d6 100644 --- a/man/step_scale.Rd +++ b/man/step_scale.Rd @@ -67,7 +67,7 @@ the variable standard deviations from the data used in the using these standard deviations. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value}, and \code{id}: \describe{ diff --git a/man/step_select.Rd b/man/step_select.Rd index 22dd78921..b61a119b2 100644 --- a/man/step_select.Rd +++ b/man/step_select.Rd @@ -56,7 +56,7 @@ specifically referenced by name. To avoid this, see the advice in the \emph{Tips for saving recipes and filtering columns} section of \link{selections}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_shuffle.Rd b/man/step_shuffle.Rd index 793489965..4b319c4eb 100644 --- a/man/step_shuffle.Rd +++ b/man/step_shuffle.Rd @@ -48,7 +48,7 @@ sequence of any existing operations. randomly change the order of rows for selected variables. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_slice.Rd b/man/step_slice.Rd index 1c84268f9..ea1caa481 100644 --- a/man/step_slice.Rd +++ b/man/step_slice.Rd @@ -65,7 +65,7 @@ before starting a preprocessing \code{\link[=recipe]{recipe()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_spatialsign.Rd b/man/step_spatialsign.Rd index a0d1771f3..330377ff5 100644 --- a/man/step_spatialsign.Rd +++ b/man/step_spatialsign.Rd @@ -62,7 +62,7 @@ The variables should be centered and scaled prior to the computations. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_spline_b.Rd b/man/step_spline_b.Rd index eda57378b..e9e6db08d 100644 --- a/man/step_spline_b.Rd +++ b/man/step_spline_b.Rd @@ -81,7 +81,7 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_spline_convex.Rd b/man/step_spline_convex.Rd index 45ff28851..1cffd4351 100644 --- a/man/step_spline_convex.Rd +++ b/man/step_spline_convex.Rd @@ -85,7 +85,7 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_spline_monotone.Rd b/man/step_spline_monotone.Rd index d81a60712..8301ea72c 100644 --- a/man/step_spline_monotone.Rd +++ b/man/step_spline_monotone.Rd @@ -86,7 +86,7 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_spline_natural.Rd b/man/step_spline_natural.Rd index 554a2e983..72c1574b8 100644 --- a/man/step_spline_natural.Rd +++ b/man/step_spline_natural.Rd @@ -79,7 +79,7 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_spline_nonnegative.Rd b/man/step_spline_nonnegative.Rd index b494b10b1..43c4a5276 100644 --- a/man/step_spline_nonnegative.Rd +++ b/man/step_spline_nonnegative.Rd @@ -89,7 +89,7 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_sqrt.Rd b/man/step_sqrt.Rd index e52288d95..3f2a2ecd3 100644 --- a/man/step_sqrt.Rd +++ b/man/step_sqrt.Rd @@ -48,7 +48,7 @@ sequence of any existing operations. square root transform to the variables. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_string2factor.Rd b/man/step_string2factor.Rd index 4a7289b6f..f5fdab170 100644 --- a/man/step_string2factor.Rd +++ b/man/step_string2factor.Rd @@ -83,7 +83,7 @@ can also take existing factors (but will leave them as-is). } } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{ordered} and \code{id}: \describe{ diff --git a/man/step_time.Rd b/man/step_time.Rd index eca53df19..76281f8f2 100644 --- a/man/step_time.Rd +++ b/man/step_time.Rd @@ -72,7 +72,7 @@ See \code{\link[=step_date]{step_date()}} if you want to calculate features that hours. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_unknown.Rd b/man/step_unknown.Rd index 82486e43e..75de7dd7b 100644 --- a/man/step_unknown.Rd +++ b/man/step_unknown.Rd @@ -63,7 +63,7 @@ If \code{new_level} is already in the data given to \code{prep}, an error is thrown. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 columns \code{terms}, \code{value} and \code{id}: \describe{ diff --git a/man/step_unorder.Rd b/man/step_unorder.Rd index 60698c4f9..246fe3d4b 100644 --- a/man/step_unorder.Rd +++ b/man/step_unorder.Rd @@ -51,7 +51,7 @@ ordered factor variables into unordered factor variables. The factors level order is preserved during the transformation. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_window.Rd b/man/step_window.Rd index 7791fe67c..6593c4ff2 100644 --- a/man/step_window.Rd +++ b/man/step_window.Rd @@ -93,7 +93,7 @@ uses \code{median(x[2:6])}. step will stop with a note about installing the package. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 columns \code{terms}, \code{statistic}, \code{size} and \code{id}: \describe{ diff --git a/man/step_zv.Rd b/man/step_zv.Rd index c120e6a76..72f0f40a6 100644 --- a/man/step_zv.Rd +++ b/man/step_zv.Rd @@ -62,7 +62,7 @@ specifically referenced by name. To avoid this, see the advice in the \emph{Tips for saving recipes and filtering columns} section of \link{selections}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 columns \code{terms} and \code{id}: \describe{ From ba6b743f391ca81eb939ace3f37613717b426e4b Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Wed, 4 Oct 2023 12:40:33 -0700 Subject: [PATCH 06/12] oxford comma --- R/BoxCox.R | 2 +- R/YeoJohnson.R | 2 +- R/center.R | 2 +- R/classdist.R | 2 +- R/classdist_shrunken.R | 2 +- R/count.R | 2 +- R/cut.R | 2 +- R/date.R | 2 +- R/depth.R | 2 +- R/discretize.R | 2 +- R/dummy.R | 2 +- R/dummy_extract.R | 2 +- R/dummy_multi_choice.R | 2 +- R/geodist.R | 2 +- R/harmonic.R | 2 +- R/holiday.R | 2 +- R/hyperbolic.R | 2 +- R/ica.R | 2 +- R/impute_bag.R | 2 +- R/impute_knn.R | 2 +- R/impute_linear.R | 2 +- R/impute_lower.R | 2 +- R/impute_mean.R | 2 +- R/impute_median.R | 2 +- R/impute_mode.R | 2 +- R/impute_roll.R | 2 +- R/integer.R | 2 +- R/isomap.R | 2 +- R/log.R | 2 +- R/mutate.R | 2 +- R/nnmf.R | 2 +- R/nnmf_sparse.R | 2 +- R/normalize.R | 2 +- R/novel.R | 2 +- R/num2factor.R | 2 +- R/other.R | 2 +- R/pca.R | 4 ++-- R/percentile.R | 2 +- R/pls.R | 2 +- R/poly.R | 2 +- R/profile.R | 2 +- R/range.R | 2 +- R/ratio.R | 2 +- R/regex.R | 2 +- R/relevel.R | 2 +- R/relu.R | 2 +- R/rename.R | 2 +- R/sample.R | 2 +- R/scale.R | 2 +- R/string2factor.R | 2 +- R/tidy.R | 4 ++-- R/time.R | 2 +- R/unknown.R | 2 +- R/window.R | 2 +- man/step_BoxCox.Rd | 2 +- man/step_YeoJohnson.Rd | 2 +- man/step_center.Rd | 2 +- man/step_classdist.Rd | 2 +- man/step_classdist_shrunken.Rd | 2 +- man/step_count.Rd | 2 +- man/step_cut.Rd | 2 +- man/step_date.Rd | 2 +- man/step_depth.Rd | 2 +- man/step_discretize.Rd | 2 +- man/step_dummy.Rd | 2 +- man/step_dummy_extract.Rd | 2 +- man/step_dummy_multi_choice.Rd | 2 +- man/step_geodist.Rd | 2 +- man/step_harmonic.Rd | 2 +- man/step_holiday.Rd | 2 +- man/step_hyperbolic.Rd | 2 +- man/step_ica.Rd | 2 +- man/step_impute_bag.Rd | 2 +- man/step_impute_knn.Rd | 2 +- man/step_impute_linear.Rd | 2 +- man/step_impute_lower.Rd | 2 +- man/step_impute_mean.Rd | 2 +- man/step_impute_median.Rd | 2 +- man/step_impute_mode.Rd | 2 +- man/step_impute_roll.Rd | 2 +- man/step_integer.Rd | 2 +- man/step_isomap.Rd | 2 +- man/step_log.Rd | 2 +- man/step_mutate.Rd | 2 +- man/step_nnmf.Rd | 2 +- man/step_nnmf_sparse.Rd | 2 +- man/step_normalize.Rd | 2 +- man/step_novel.Rd | 2 +- man/step_num2factor.Rd | 2 +- man/step_other.Rd | 2 +- man/step_pca.Rd | 4 ++-- man/step_percentile.Rd | 2 +- man/step_pls.Rd | 2 +- man/step_poly.Rd | 2 +- man/step_profile.Rd | 2 +- man/step_range.Rd | 2 +- man/step_ratio.Rd | 2 +- man/step_regex.Rd | 2 +- man/step_relevel.Rd | 2 +- man/step_relu.Rd | 2 +- man/step_rename.Rd | 2 +- man/step_sample.Rd | 2 +- man/step_scale.Rd | 2 +- man/step_string2factor.Rd | 2 +- man/step_time.Rd | 2 +- man/step_unknown.Rd | 2 +- man/step_window.Rd | 2 +- man/tidy.recipe.Rd | 4 ++-- 108 files changed, 112 insertions(+), 112 deletions(-) diff --git a/R/BoxCox.R b/R/BoxCox.R index 6e767b7d1..9937edcd6 100644 --- a/R/BoxCox.R +++ b/R/BoxCox.R @@ -34,7 +34,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/YeoJohnson.R b/R/YeoJohnson.R index 3445037fa..4b510ff0f 100644 --- a/R/YeoJohnson.R +++ b/R/YeoJohnson.R @@ -33,7 +33,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/center.R b/R/center.R index 5871c8022..1a2a1ce06 100644 --- a/R/center.R +++ b/R/center.R @@ -35,7 +35,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/classdist.R b/R/classdist.R index 8f2b26c63..215bddb43 100644 --- a/R/classdist.R +++ b/R/classdist.R @@ -43,7 +43,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `value`, `class` and `id`: +#' columns `terms`, `value`, `class` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/classdist_shrunken.R b/R/classdist_shrunken.R index 72cf691a5..cbab10d94 100644 --- a/R/classdist_shrunken.R +++ b/R/classdist_shrunken.R @@ -41,7 +41,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 6 -#' columns `terms`, `value`, `class`, `type`, `threshold` and `id`: +#' columns `terms`, `value`, `class`, `type`, `threshold` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/count.R b/R/count.R index 995856d7d..a5a675edb 100644 --- a/R/count.R +++ b/R/count.R @@ -27,7 +27,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `result` and `id`: +#' columns `terms`, `result` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/cut.R b/R/cut.R index c40636726..42ee851fa 100644 --- a/R/cut.R +++ b/R/cut.R @@ -22,7 +22,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/date.R b/R/date.R index e58e3ab00..eac5232f8 100644 --- a/R/date.R +++ b/R/date.R @@ -51,7 +51,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `value`, `ordinal` and `id`: +#' columns `terms`, `value`, `ordinal` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/depth.R b/R/depth.R index 65dff8a97..c0da70b93 100644 --- a/R/depth.R +++ b/R/depth.R @@ -54,7 +54,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `class` and `id`: +#' columns `terms`, `class` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/discretize.R b/R/discretize.R index 62c1f9be4..8080dfa81 100644 --- a/R/discretize.R +++ b/R/discretize.R @@ -260,7 +260,7 @@ print.discretize <- #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/dummy.R b/R/dummy.R index eb24e5bce..2774fc714 100644 --- a/R/dummy.R +++ b/R/dummy.R @@ -68,7 +68,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `columns` and `id`: +#' columns `terms`, `columns` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/dummy_extract.R b/R/dummy_extract.R index 4296ea2e1..283733417 100644 --- a/R/dummy_extract.R +++ b/R/dummy_extract.R @@ -34,7 +34,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `columns` and `id`: +#' columns `terms`, `columns` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/dummy_multi_choice.R b/R/dummy_multi_choice.R index cb2d3c99a..c5ac3d192 100644 --- a/R/dummy_multi_choice.R +++ b/R/dummy_multi_choice.R @@ -32,7 +32,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `columns` and `id`: +#' columns `terms`, `columns` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/geodist.R b/R/geodist.R index 5b7b18281..e05b2316a 100644 --- a/R/geodist.R +++ b/R/geodist.R @@ -30,7 +30,7 @@ #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 7 #' columns `latitude`, `longitude`, `ref_latitude`, `ref_longitude`, -#' `is_lat_lon`, `name` and `id`: +#' `is_lat_lon`, `name` , and `id`: #' #' \describe{ #' \item{latitude}{character, name of latitude variable} diff --git a/R/harmonic.R b/R/harmonic.R index 09e351150..eabc373b5 100644 --- a/R/harmonic.R +++ b/R/harmonic.R @@ -67,7 +67,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 6 -#' columns `terms`, `starting_val`, `cycle_size`, `frequency`, `key`, and `id`: +#' columns `terms`, `starting_val`, `cycle_size`, `frequency`, `key` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/holiday.R b/R/holiday.R index 99d5ddc3d..979ee99b1 100644 --- a/R/holiday.R +++ b/R/holiday.R @@ -20,7 +20,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `holiday` and `id`: +#' columns `terms`, `holiday` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/hyperbolic.R b/R/hyperbolic.R index 35e0dabc1..aa9a226d3 100644 --- a/R/hyperbolic.R +++ b/R/hyperbolic.R @@ -16,7 +16,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `inverse`, `func` and `id`: +#' columns `terms`, `inverse`, `func` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/ica.R b/R/ica.R index 120a1e730..5292c60b6 100644 --- a/R/ica.R +++ b/R/ica.R @@ -42,7 +42,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `component`, `value` and `id`: +#' columns `terms`, `component`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/impute_bag.R b/R/impute_bag.R index cabba7d50..e0a562cb4 100644 --- a/R/impute_bag.R +++ b/R/impute_bag.R @@ -50,7 +50,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `model` and `id`: +#' columns `terms`, `model` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/impute_knn.R b/R/impute_knn.R index dae25aac5..038195d2e 100644 --- a/R/impute_knn.R +++ b/R/impute_knn.R @@ -35,7 +35,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `predictors`, `neighbors` and `id`: +#' columns `terms`, `predictors`, `neighbors` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/impute_linear.R b/R/impute_linear.R index 806d7521e..9fa6dfc66 100644 --- a/R/impute_linear.R +++ b/R/impute_linear.R @@ -29,7 +29,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `model` and `id`: +#' columns `terms`, `model` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/impute_lower.R b/R/impute_lower.R index 2b701ed58..903e88b93 100644 --- a/R/impute_lower.R +++ b/R/impute_lower.R @@ -23,7 +23,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/impute_mean.R b/R/impute_mean.R index 2d7f51456..3e4e6436f 100644 --- a/R/impute_mean.R +++ b/R/impute_mean.R @@ -24,7 +24,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `model` and `id`: +#' columns `terms`, `model` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/impute_median.R b/R/impute_median.R index f724d3e5a..ee6b1d91d 100644 --- a/R/impute_median.R +++ b/R/impute_median.R @@ -21,7 +21,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `model` and `id`: +#' columns `terms`, `model` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/impute_mode.R b/R/impute_mode.R index d1c4611d1..49a211c24 100644 --- a/R/impute_mode.R +++ b/R/impute_mode.R @@ -24,7 +24,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/impute_roll.R b/R/impute_roll.R index 071685d7a..ecec163b2 100644 --- a/R/impute_roll.R +++ b/R/impute_roll.R @@ -40,7 +40,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `window` and `id`: +#' columns `terms`, `window` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/integer.R b/R/integer.R index b174b6d34..15dab5ea2 100644 --- a/R/integer.R +++ b/R/integer.R @@ -32,7 +32,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/isomap.R b/R/isomap.R index fc00ac530..3e0e638bb 100644 --- a/R/isomap.R +++ b/R/isomap.R @@ -46,7 +46,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 -#' columns `terms` and `id`: +#' columns `terms` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/log.R b/R/log.R index de5eb7bda..416172be2 100644 --- a/R/log.R +++ b/R/log.R @@ -19,7 +19,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `base` and `id`: +#' columns `terms`, `base` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/mutate.R b/R/mutate.R index b9e978a20..ece602865 100644 --- a/R/mutate.R +++ b/R/mutate.R @@ -21,7 +21,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/nnmf.R b/R/nnmf.R index 5baba637e..479acf131 100644 --- a/R/nnmf.R +++ b/R/nnmf.R @@ -40,7 +40,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `value`, `component` and `id`: +#' columns `terms`, `value`, `component` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/nnmf_sparse.R b/R/nnmf_sparse.R index 2f3645223..699b9b831 100644 --- a/R/nnmf_sparse.R +++ b/R/nnmf_sparse.R @@ -32,7 +32,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `value`, `component` and `id`: +#' columns `terms`, `value`, `component` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/normalize.R b/R/normalize.R index 9c43cb64e..78d1ab236 100644 --- a/R/normalize.R +++ b/R/normalize.R @@ -24,7 +24,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `statistic`, `value` and `id`: +#' columns `terms`, `statistic`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/novel.R b/R/novel.R index 089a42c6b..61c356d8e 100644 --- a/R/novel.R +++ b/R/novel.R @@ -34,7 +34,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/num2factor.R b/R/num2factor.R index 9404ce0e8..a13c18455 100644 --- a/R/num2factor.R +++ b/R/num2factor.R @@ -20,7 +20,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `ordered` and `id`: +#' columns `terms`, `ordered` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/other.R b/R/other.R index 20f11c8be..be7b84e06 100644 --- a/R/other.R +++ b/R/other.R @@ -44,7 +44,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `retained` and `id`: +#' columns `terms`, `retained` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/pca.R b/R/pca.R index 341b721b5..f61c3af32 100644 --- a/R/pca.R +++ b/R/pca.R @@ -62,7 +62,7 @@ #' #' When you [`tidy()`][tidy.recipe()] this step two things can happen depending #' the `type` argument. If `type = "coef"` a tibble returned with 4 columns -#' `terms`, `value`, `component` and `id`: +#' `terms`, `value`, `component` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} @@ -72,7 +72,7 @@ #' } #' #' If `type = "variance"` a tibble returned with 4 columns `terms`, `value`, -#' `component` and `id`: +#' `component` , and `id`: #' #' \describe{ #' \item{terms}{character, type of variance} diff --git a/R/percentile.R b/R/percentile.R index 32d93bd6a..426ab385c 100644 --- a/R/percentile.R +++ b/R/percentile.R @@ -25,7 +25,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `value`, `percentile` and `id`: +#' columns `terms`, `value`, `percentile` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/pls.R b/R/pls.R index 06caa0825..de4abee70 100644 --- a/R/pls.R +++ b/R/pls.R @@ -42,7 +42,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `value`, `component` and `id`: +#' columns `terms`, `value`, `component` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/poly.R b/R/poly.R index 75a09eb51..a6cfcdbdd 100644 --- a/R/poly.R +++ b/R/poly.R @@ -32,7 +32,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `degree` and `id`: +#' columns `terms`, `degree` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/profile.R b/R/profile.R index 36069472c..a4b7fe57c 100644 --- a/R/profile.R +++ b/R/profile.R @@ -39,7 +39,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `type` and `id`: +#' columns `terms`, `type` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/range.R b/R/range.R index 4de6c5407..e4e02ae3f 100644 --- a/R/range.R +++ b/R/range.R @@ -25,7 +25,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `min`, `max` and `id`: +#' columns `terms`, `min`, `max` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/ratio.R b/R/ratio.R index deae0275f..11890a156 100644 --- a/R/ratio.R +++ b/R/ratio.R @@ -30,7 +30,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `denom` and `id`: +#' columns `terms`, `denom` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/regex.R b/R/regex.R index b099b03cd..dea38eea5 100644 --- a/R/regex.R +++ b/R/regex.R @@ -25,7 +25,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `result` and `id`: +#' columns `terms`, `result` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/relevel.R b/R/relevel.R index aa8739269..74c92d678 100644 --- a/R/relevel.R +++ b/R/relevel.R @@ -25,7 +25,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/relu.R b/R/relu.R index 144a4a774..2eb18593d 100644 --- a/R/relu.R +++ b/R/relu.R @@ -42,7 +42,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `shift`, `reverse` and `id`: +#' columns `terms`, `shift`, `reverse` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/rename.R b/R/rename.R index 7c6758151..c5b7d0e89 100644 --- a/R/rename.R +++ b/R/rename.R @@ -17,7 +17,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/sample.R b/R/sample.R index e84969f50..1e895ecb5 100644 --- a/R/sample.R +++ b/R/sample.R @@ -19,7 +19,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `size`, `replace` and `id`: +#' columns `terms`, `size`, `replace` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/scale.R b/R/scale.R index ce21695b3..012319385 100644 --- a/R/scale.R +++ b/R/scale.R @@ -26,7 +26,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value`, and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/string2factor.R b/R/string2factor.R index c99a980c1..dc421e774 100644 --- a/R/string2factor.R +++ b/R/string2factor.R @@ -47,7 +47,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `ordered` and `id`: +#' columns `terms`, `ordered` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/tidy.R b/R/tidy.R index f3b5fbd10..a7280a1d8 100644 --- a/R/tidy.R +++ b/R/tidy.R @@ -7,7 +7,7 @@ #' @name tidy.recipe #' #' @param x A `recipe` object, step, or check (trained or otherwise). -#' @param number An integer or `NA`. If missing and `id` is not provided, +#' @param number An integer or `NA`. If missing , and `id` is not provided, #' the return value is a list of the operations in the recipe. #' If a number is given, a `tidy` method is executed for that operation #' in the recipe (if it exists). `number` must not be provided if @@ -19,7 +19,7 @@ #' if `number` is. #' @param ... Not currently used. #' @return A tibble with columns that vary depending on what -#' `tidy` method is executed. When `number` and `id` are `NA`, a +#' `tidy` method is executed. When `number` , and `id` are `NA`, a #' tibble with columns `number` (the operation iteration), #' `operation` (either "step" or "check"), #' `type` (the method, e.g. "nzv", "center"), a logical diff --git a/R/time.R b/R/time.R index 8ac49bea9..b0082cec4 100644 --- a/R/time.R +++ b/R/time.R @@ -31,7 +31,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/unknown.R b/R/unknown.R index dca5cc144..30c23b48f 100644 --- a/R/unknown.R +++ b/R/unknown.R @@ -25,7 +25,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 -#' columns `terms`, `value` and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/window.R b/R/window.R index f6522bd6e..4880d3e3a 100644 --- a/R/window.R +++ b/R/window.R @@ -45,7 +45,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 -#' columns `terms`, `statistic`, `size` and `id`: +#' columns `terms`, `statistic`, `size` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/man/step_BoxCox.Rd b/man/step_BoxCox.Rd index 3f281545b..7d37b8042 100644 --- a/man/step_BoxCox.Rd +++ b/man/step_BoxCox.Rd @@ -76,7 +76,7 @@ closed to the bounds, or if the optimization fails, a value of } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_YeoJohnson.Rd b/man/step_YeoJohnson.Rd index 78d1bba12..45699440e 100644 --- a/man/step_YeoJohnson.Rd +++ b/man/step_YeoJohnson.Rd @@ -79,7 +79,7 @@ closed to the bounds, or if the optimization fails, a value of } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_center.Rd b/man/step_center.Rd index f764662d6..bf1097b73 100644 --- a/man/step_center.Rd +++ b/man/step_center.Rd @@ -60,7 +60,7 @@ the centering to new data sets using these means. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_classdist.Rd b/man/step_classdist.Rd index e84724582..e5ecf6d88 100644 --- a/man/step_classdist.Rd +++ b/man/step_classdist.Rd @@ -99,7 +99,7 @@ overall. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{value}, \code{class} and \code{id}: +columns \code{terms}, \code{value}, \code{class} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_classdist_shrunken.Rd b/man/step_classdist_shrunken.Rd index 51628e63e..8aa09c292 100644 --- a/man/step_classdist_shrunken.Rd +++ b/man/step_classdist_shrunken.Rd @@ -98,7 +98,7 @@ be changed using the \code{prefix} argument. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 6 -columns \code{terms}, \code{value}, \code{class}, \code{type}, \code{threshold} and \code{id}: +columns \code{terms}, \code{value}, \code{class}, \code{type}, \code{threshold} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_count.Rd b/man/step_count.Rd index a89f7c229..331a1ab57 100644 --- a/man/step_count.Rd +++ b/man/step_count.Rd @@ -74,7 +74,7 @@ variable that counts instances of a regular expression pattern in text. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{result} and \code{id}: +columns \code{terms}, \code{result} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_cut.Rd b/man/step_cut.Rd index 1badf58ac..33c373af5 100644 --- a/man/step_cut.Rd +++ b/man/step_cut.Rd @@ -62,7 +62,7 @@ points will end up in the last. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_date.Rd b/man/step_date.Rd index f0888411c..c4e1e1f5f 100644 --- a/man/step_date.Rd +++ b/man/step_date.Rd @@ -98,7 +98,7 @@ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns names), and \code{ordinal} (a logical) is returned. When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{value}, \code{ordinal} and \code{id}: +columns \code{terms}, \code{value}, \code{ordinal} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_depth.Rd b/man/step_depth.Rd index 0b2896d0b..9650b3769 100644 --- a/man/step_depth.Rd +++ b/man/step_depth.Rd @@ -106,7 +106,7 @@ naming format can be changed using the \code{prefix} argument. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{class} and \code{id}: +columns \code{terms}, \code{class} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_discretize.Rd b/man/step_discretize.Rd index a0d692394..6149154fb 100644 --- a/man/step_discretize.Rd +++ b/man/step_discretize.Rd @@ -68,7 +68,7 @@ number of data points (based on a training set). } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_dummy.Rd b/man/step_dummy.Rd index b2ba6e836..9c0687a2d 100644 --- a/man/step_dummy.Rd +++ b/man/step_dummy.Rd @@ -114,7 +114,7 @@ and interactions has more information. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{columns} and \code{id}: +columns \code{terms}, \code{columns} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_dummy_extract.Rd b/man/step_dummy_extract.Rd index 83d6c5e5c..dd5ae0445 100644 --- a/man/step_dummy_extract.Rd +++ b/man/step_dummy_extract.Rd @@ -98,7 +98,7 @@ default. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{columns} and \code{id}: +columns \code{terms}, \code{columns} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_dummy_multi_choice.Rd b/man/step_dummy_multi_choice.Rd index acb0e8272..10b287222 100644 --- a/man/step_dummy_multi_choice.Rd +++ b/man/step_dummy_multi_choice.Rd @@ -100,7 +100,7 @@ This step has 1 tuning parameters: \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{columns} and \code{id}: +columns \code{terms}, \code{columns} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_geodist.Rd b/man/step_geodist.Rd index dc3abd860..0220f8e67 100644 --- a/man/step_geodist.Rd +++ b/man/step_geodist.Rd @@ -81,7 +81,7 @@ formula is used to calculate the great-circle distance in meters. \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 7 columns \code{latitude}, \code{longitude}, \code{ref_latitude}, \code{ref_longitude}, -\code{is_lat_lon}, \code{name} and \code{id}: +\code{is_lat_lon}, \code{name} , and \code{id}: \describe{ \item{latitude}{character, name of latitude variable} diff --git a/man/step_harmonic.Rd b/man/step_harmonic.Rd index 062fb1957..748a5aa5f 100644 --- a/man/step_harmonic.Rd +++ b/man/step_harmonic.Rd @@ -114,7 +114,7 @@ This step has 1 tuning parameters: \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 6 -columns \code{terms}, \code{starting_val}, \code{cycle_size}, \code{frequency}, \code{key}, and \code{id}: +columns \code{terms}, \code{starting_val}, \code{cycle_size}, \code{frequency}, \code{key} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_holiday.Rd b/man/step_holiday.Rd index 16312bb56..9ebe5225a 100644 --- a/man/step_holiday.Rd +++ b/man/step_holiday.Rd @@ -65,7 +65,7 @@ to \code{FALSE} to remove them. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{holiday} and \code{id}: +columns \code{terms}, \code{holiday} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_hyperbolic.Rd b/man/step_hyperbolic.Rd index f74190c88..aa45b6d26 100644 --- a/man/step_hyperbolic.Rd +++ b/man/step_hyperbolic.Rd @@ -56,7 +56,7 @@ transform data using a hyperbolic function. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{inverse}, \code{func} and \code{id}: +columns \code{terms}, \code{inverse}, \code{func} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_ica.Rd b/man/step_ica.Rd index 97674bef0..109643b7d 100644 --- a/man/step_ica.Rd +++ b/man/step_ica.Rd @@ -104,7 +104,7 @@ the names would be \code{IC1} - \code{IC101}. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{component}, \code{value} and \code{id}: +columns \code{terms}, \code{component}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_impute_bag.Rd b/man/step_impute_bag.Rd index cc0a6c565..589b92f81 100644 --- a/man/step_impute_bag.Rd +++ b/man/step_impute_bag.Rd @@ -110,7 +110,7 @@ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns (the bagged tree object) is returned. When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{model} and \code{id}: +columns \code{terms}, \code{model} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_impute_knn.Rd b/man/step_impute_knn.Rd index 73129508a..1a9747120 100644 --- a/man/step_impute_knn.Rd +++ b/man/step_impute_knn.Rd @@ -103,7 +103,7 @@ to \code{step_impute_knn()}. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{predictors}, \code{neighbors} and \code{id}: +columns \code{terms}, \code{predictors}, \code{neighbors} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_impute_linear.Rd b/man/step_impute_linear.Rd index fb22496c7..125289415 100644 --- a/man/step_impute_linear.Rd +++ b/man/step_impute_linear.Rd @@ -71,7 +71,7 @@ cases for the training set predictors. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{model} and \code{id}: +columns \code{terms}, \code{model} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_impute_lower.Rd b/man/step_impute_lower.Rd index f9aee8a6a..e96bb2e94 100644 --- a/man/step_impute_lower.Rd +++ b/man/step_impute_lower.Rd @@ -72,7 +72,7 @@ to \code{step_impute_lower()}. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_impute_mean.Rd b/man/step_impute_mean.Rd index 7ca72b9e6..e5954e915 100644 --- a/man/step_impute_mean.Rd +++ b/man/step_impute_mean.Rd @@ -76,7 +76,7 @@ to \code{step_impute_mean()}. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{model} and \code{id}: +columns \code{terms}, \code{model} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_impute_median.Rd b/man/step_impute_median.Rd index 99aac9760..8a05ccf68 100644 --- a/man/step_impute_median.Rd +++ b/man/step_impute_median.Rd @@ -70,7 +70,7 @@ As of \code{recipes} 0.1.16, this function name changed from } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{model} and \code{id}: +columns \code{terms}, \code{model} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_impute_mode.Rd b/man/step_impute_mode.Rd index a169c8f3f..635173d49 100644 --- a/man/step_impute_mode.Rd +++ b/man/step_impute_mode.Rd @@ -76,7 +76,7 @@ to \code{step_impute_mode()}. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_impute_roll.Rd b/man/step_impute_roll.Rd index e2ff3216a..49223d860 100644 --- a/man/step_impute_roll.Rd +++ b/man/step_impute_roll.Rd @@ -93,7 +93,7 @@ to \code{step_impute_roll()}. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{window} and \code{id}: +columns \code{terms}, \code{window} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_integer.Rd b/man/step_integer.Rd index 40075b469..6bb202949 100644 --- a/man/step_integer.Rd +++ b/man/step_integer.Rd @@ -74,7 +74,7 @@ Despite the name, the new values are returned as numeric unless } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_isomap.Rd b/man/step_isomap.Rd index 33e016e39..1a83470c1 100644 --- a/man/step_isomap.Rd +++ b/man/step_isomap.Rd @@ -101,7 +101,7 @@ if \code{num_terms < 10}, their names will be \code{Isomap1} - } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 -columns \code{terms} and \code{id}: +columns \code{terms} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_log.Rd b/man/step_log.Rd index f1023ba16..fbb392329 100644 --- a/man/step_log.Rd +++ b/man/step_log.Rd @@ -61,7 +61,7 @@ transform data. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{base} and \code{id}: +columns \code{terms}, \code{base} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_mutate.Rd b/man/step_mutate.Rd index 6250834f3..476efe8c2 100644 --- a/man/step_mutate.Rd +++ b/man/step_mutate.Rd @@ -63,7 +63,7 @@ If a preceding step removes a column that is selected by name in } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_nnmf.Rd b/man/step_nnmf.Rd index 96f151363..b98eaafeb 100644 --- a/man/step_nnmf.Rd +++ b/man/step_nnmf.Rd @@ -100,7 +100,7 @@ the names would be \code{NNMF1} - \code{NNMF101}. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{value}, \code{component} and \code{id}: +columns \code{terms}, \code{value}, \code{component} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_nnmf_sparse.Rd b/man/step_nnmf_sparse.Rd index f27b0038c..326d8f0a3 100644 --- a/man/step_nnmf_sparse.Rd +++ b/man/step_nnmf_sparse.Rd @@ -92,7 +92,7 @@ the names would be \code{NNMF1} - \code{NNMF101}. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{value}, \code{component} and \code{id}: +columns \code{terms}, \code{value}, \code{component} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_normalize.Rd b/man/step_normalize.Rd index 2abb2b4a8..e5676b37f 100644 --- a/man/step_normalize.Rd +++ b/man/step_normalize.Rd @@ -66,7 +66,7 @@ these estimates. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{statistic}, \code{value} and \code{id}: +columns \code{terms}, \code{statistic}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_novel.Rd b/man/step_novel.Rd index cfee7afce..51a9ad558 100644 --- a/man/step_novel.Rd +++ b/man/step_novel.Rd @@ -73,7 +73,7 @@ new levels at prediction time, instead of throwing warnings or errors. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_num2factor.Rd b/man/step_num2factor.Rd index e2c6385af..b4aa0168d 100644 --- a/man/step_num2factor.Rd +++ b/man/step_num2factor.Rd @@ -61,7 +61,7 @@ integers. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{ordered} and \code{id}: +columns \code{terms}, \code{ordered} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_other.Rd b/man/step_other.Rd index 153b63c3d..89ae9eb6f 100644 --- a/man/step_other.Rd +++ b/man/step_other.Rd @@ -85,7 +85,7 @@ contained in the training set), the other category is assigned. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{retained} and \code{id}: +columns \code{terms}, \code{retained} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_pca.Rd b/man/step_pca.Rd index 679b978c5..ba8501ebf 100644 --- a/man/step_pca.Rd +++ b/man/step_pca.Rd @@ -108,7 +108,7 @@ fraction of the total variance in the variables. \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step two things can happen depending the \code{type} argument. If \code{type = "coef"} a tibble returned with 4 columns -\code{terms}, \code{value}, \code{component} and \code{id}: +\code{terms}, \code{value}, \code{component} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} @@ -118,7 +118,7 @@ the \code{type} argument. If \code{type = "coef"} a tibble returned with 4 colum } If \code{type = "variance"} a tibble returned with 4 columns \code{terms}, \code{value}, -\code{component} and \code{id}: +\code{component} , and \code{id}: \describe{ \item{terms}{character, type of variance} diff --git a/man/step_percentile.Rd b/man/step_percentile.Rd index 2360fafd9..25243f2b6 100644 --- a/man/step_percentile.Rd +++ b/man/step_percentile.Rd @@ -62,7 +62,7 @@ the value of a variable with its percentile from the training set. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{value}, \code{percentile} and \code{id}: +columns \code{terms}, \code{value}, \code{percentile} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_pls.Rd b/man/step_pls.Rd index 82148a63c..fa0b3a049 100644 --- a/man/step_pls.Rd +++ b/man/step_pls.Rd @@ -108,7 +108,7 @@ proportion to determine the \code{keepX} parameter in \code{mixOmics::spls()} an } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{value}, \code{component} and \code{id}: +columns \code{terms}, \code{value}, \code{component} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_poly.Rd b/man/step_poly.Rd index 5a8a134de..f510b82a1 100644 --- a/man/step_poly.Rd +++ b/man/step_poly.Rd @@ -76,7 +76,7 @@ expansion pick up the same signal as their uncorrelated counterpart. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{degree} and \code{id}: +columns \code{terms}, \code{degree} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_profile.Rd b/man/step_profile.Rd index dfed6b724..07eb5b9d6 100644 --- a/man/step_profile.Rd +++ b/man/step_profile.Rd @@ -89,7 +89,7 @@ based on the fixed and profiled variable's information. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{type} and \code{id}: +columns \code{terms}, \code{type} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_range.Rd b/man/step_range.Rd index ca318f091..b20a6ef95 100644 --- a/man/step_range.Rd +++ b/man/step_range.Rd @@ -69,7 +69,7 @@ the training set, the new values are truncated at \code{min} or } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{min}, \code{max} and \code{id}: +columns \code{terms}, \code{min}, \code{max} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_ratio.Rd b/man/step_ratio.Rd index df463c09c..f5487718a 100644 --- a/man/step_ratio.Rd +++ b/man/step_ratio.Rd @@ -77,7 +77,7 @@ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns \code{terms} (the selectors or variables selected) and \code{denom} is returned. When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{denom} and \code{id}: +columns \code{terms}, \code{denom} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_regex.Rd b/man/step_regex.Rd index 33a78895d..68f7e0057 100644 --- a/man/step_regex.Rd +++ b/man/step_regex.Rd @@ -70,7 +70,7 @@ new dummy variable based on a regular expression. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{result} and \code{id}: +columns \code{terms}, \code{result} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_relevel.Rd b/man/step_relevel.Rd index 2fbd448af..645d33858 100644 --- a/man/step_relevel.Rd +++ b/man/step_relevel.Rd @@ -63,7 +63,7 @@ converted to factors by this step. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_relu.Rd b/man/step_relu.Rd index 56eefe4b5..3c2ce00ec 100644 --- a/man/step_relu.Rd +++ b/man/step_relu.Rd @@ -86,7 +86,7 @@ residuals only if they are within a certain margin of the decision boundary. \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{shift}, \code{reverse} and \code{id}: +columns \code{terms}, \code{shift}, \code{reverse} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_rename.Rd b/man/step_rename.Rd index feffd0065..11e8945cb 100644 --- a/man/step_rename.Rd +++ b/man/step_rename.Rd @@ -55,7 +55,7 @@ expression (to be portable between sessions). } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_sample.Rd b/man/step_sample.Rd index 52aeafa9f..6743f660c 100644 --- a/man/step_sample.Rd +++ b/man/step_sample.Rd @@ -66,7 +66,7 @@ before starting a preprocessing \code{\link[=recipe]{recipe()}}. \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{size}, \code{replace} and \code{id}: +columns \code{terms}, \code{size}, \code{replace} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_scale.Rd b/man/step_scale.Rd index 979b276d6..9ebb5601e 100644 --- a/man/step_scale.Rd +++ b/man/step_scale.Rd @@ -68,7 +68,7 @@ using these standard deviations. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value}, and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_string2factor.Rd b/man/step_string2factor.Rd index f5fdab170..8a8789199 100644 --- a/man/step_string2factor.Rd +++ b/man/step_string2factor.Rd @@ -84,7 +84,7 @@ can also take existing factors (but will leave them as-is). } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{ordered} and \code{id}: +columns \code{terms}, \code{ordered} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_time.Rd b/man/step_time.Rd index 76281f8f2..1e3ab2fca 100644 --- a/man/step_time.Rd +++ b/man/step_time.Rd @@ -73,7 +73,7 @@ hours. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_unknown.Rd b/man/step_unknown.Rd index 75de7dd7b..35a578403 100644 --- a/man/step_unknown.Rd +++ b/man/step_unknown.Rd @@ -64,7 +64,7 @@ is thrown. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 -columns \code{terms}, \code{value} and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_window.Rd b/man/step_window.Rd index 6593c4ff2..c1c7652c4 100644 --- a/man/step_window.Rd +++ b/man/step_window.Rd @@ -94,7 +94,7 @@ step will stop with a note about installing the package. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 -columns \code{terms}, \code{statistic}, \code{size} and \code{id}: +columns \code{terms}, \code{statistic}, \code{size} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/tidy.recipe.Rd b/man/tidy.recipe.Rd index bf0abdb14..83ea9f365 100644 --- a/man/tidy.recipe.Rd +++ b/man/tidy.recipe.Rd @@ -328,7 +328,7 @@ component) or \code{"variance"} (how much variance does each component account for).} -\item{number}{An integer or \code{NA}. If missing and \code{id} is not provided, +\item{number}{An integer or \code{NA}. If missing , and \code{id} is not provided, the return value is a list of the operations in the recipe. If a number is given, a \code{tidy} method is executed for that operation in the recipe (if it exists). \code{number} must not be provided if @@ -342,7 +342,7 @@ if \code{number} is.} } \value{ A tibble with columns that vary depending on what -\code{tidy} method is executed. When \code{number} and \code{id} are \code{NA}, a +\code{tidy} method is executed. When \code{number} , and \code{id} are \code{NA}, a tibble with columns \code{number} (the operation iteration), \code{operation} (either "step" or "check"), \code{type} (the method, e.g. "nzv", "center"), a logical From 88ac4af66268b2118a19ef323d7e49b15190149f Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Wed, 4 Oct 2023 12:44:15 -0700 Subject: [PATCH 07/12] Apply suggestions from code review Co-authored-by: Simon P. Couch --- NEWS.md | 2 +- R/classdist_shrunken.R | 4 ++-- R/corr.R | 2 +- R/hyperbolic.R | 2 +- R/normalize.R | 4 ++-- R/novel.R | 2 +- R/other.R | 2 +- R/pls.R | 2 +- R/profile.R | 2 +- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/NEWS.md b/NEWS.md index 75439c4d8..417653f2c 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,7 +2,7 @@ * Document that `update_role()`, `add_role()` and `remove_role()` are applied before steps and checks. (#778) -* Documentation for tidy methods for all steps have been added when missing and improved to describe whole outcome. (#936) +* Documentation for tidy methods for all steps has been added when missing and improved to describe the return value more accurately. (#936) # recipes 1.0.8 diff --git a/R/classdist_shrunken.R b/R/classdist_shrunken.R index cbab10d94..9cc2cb01d 100644 --- a/R/classdist_shrunken.R +++ b/R/classdist_shrunken.R @@ -47,13 +47,13 @@ #' \item{terms}{character, the selectors or variables selected} #' \item{value}{numeric, the centroid} #' \item{class}{character, name of class variable} -#' \item{type}{character, has values global, by_class, and shrunken} +#' \item{type}{character, has values `"global"`, `"by_class"`, and `"shrunken"`} #' \item{threshold}{numeric, value of threshold} #' \item{id}{character, id of this step} #' } #' #' The first two types of centroids are in the original units while the last -#' have been standardized. +#' has been standardized. #' #' @template case-weights-supervised #' @references diff --git a/R/corr.R b/R/corr.R index 6ce0720cc..c1efe63dc 100644 --- a/R/corr.R +++ b/R/corr.R @@ -43,7 +43,7 @@ #' columns `terms` and `id`: #' #' \describe{ -#' \item{terms}{character, the selectors or variables selected} +#' \item{terms}{character, the selectors or variables selected to be removed} #' \item{id}{character, id of this step} #' } #' diff --git a/R/hyperbolic.R b/R/hyperbolic.R index aa9a226d3..83df31946 100644 --- a/R/hyperbolic.R +++ b/R/hyperbolic.R @@ -21,7 +21,7 @@ #' \describe{ #' \item{terms}{character, the selectors or variables selected} #' \item{inverse}{logical, is the inverse function be used} -#' \item{func}{character, name of function. "sinh", "cosh", or "tanh"} +#' \item{func}{character, name of function. `"sinh"`, `"cosh"`, or `"tanh"`} #' \item{id}{character, id of this step} #' } #' diff --git a/R/normalize.R b/R/normalize.R index 78d1ab236..efc8cbf44 100644 --- a/R/normalize.R +++ b/R/normalize.R @@ -28,8 +28,8 @@ #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} -#' \item{statistic}{character, name of statistic, mean or sd} -#' \item{value}{numeric, value statistic} +#' \item{statistic}{character, name of statistic (`"mean"` or `"sd"`)} +#' \item{value}{numeric, value of the `statistic`} #' \item{id}{character, id of this step} #' } #' diff --git a/R/novel.R b/R/novel.R index 61c356d8e..d2eca54db 100644 --- a/R/novel.R +++ b/R/novel.R @@ -38,7 +38,7 @@ #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} -#' \item{value}{character, the factor levels that is used for the new value} +#' \item{value}{character, the factor levels that are used for the new value} #' \item{id}{character, id of this step} #' } #' diff --git a/R/other.R b/R/other.R index be7b84e06..39fec0d80 100644 --- a/R/other.R +++ b/R/other.R @@ -48,7 +48,7 @@ #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} -#' \item{retained}{character, factor levels not pulled into "other"} +#' \item{retained}{character, factor levels not pulled into `"other"`} #' \item{id}{character, id of this step} #' } #' diff --git a/R/pls.R b/R/pls.R index de4abee70..3b99ae6a9 100644 --- a/R/pls.R +++ b/R/pls.R @@ -46,7 +46,7 @@ #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} -#' \item{value}{numeric, coeficients defined as \eqn{W(P'W)^{-1}}} +#' \item{value}{numeric, coefficients defined as \eqn{W(P'W)^{-1}}} #' \item{size}{character, name of component} #' \item{id}{character, id of this step} #' } diff --git a/R/profile.R b/R/profile.R index a4b7fe57c..e1c99cb00 100644 --- a/R/profile.R +++ b/R/profile.R @@ -43,7 +43,7 @@ #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} -#' \item{type}{character, fixed or profiled} +#' \item{type}{character, `"fixed"` or `"profiled"`} #' \item{id}{character, id of this step} #' } #' From 701f5dfd54969400c8e434d727d8e039edae3553 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Wed, 4 Oct 2023 12:44:43 -0700 Subject: [PATCH 08/12] reknit --- man/step_classdist_shrunken.Rd | 4 ++-- man/step_corr.Rd | 2 +- man/step_hyperbolic.Rd | 2 +- man/step_normalize.Rd | 4 ++-- man/step_novel.Rd | 2 +- man/step_other.Rd | 2 +- man/step_pls.Rd | 2 +- man/step_profile.Rd | 2 +- 8 files changed, 10 insertions(+), 10 deletions(-) diff --git a/man/step_classdist_shrunken.Rd b/man/step_classdist_shrunken.Rd index 8aa09c292..9d8048ac3 100644 --- a/man/step_classdist_shrunken.Rd +++ b/man/step_classdist_shrunken.Rd @@ -104,13 +104,13 @@ columns \code{terms}, \code{value}, \code{class}, \code{type}, \code{threshold} \item{terms}{character, the selectors or variables selected} \item{value}{numeric, the centroid} \item{class}{character, name of class variable} -\item{type}{character, has values global, by_class, and shrunken} +\item{type}{character, has values \code{"global"}, \code{"by_class"}, and \code{"shrunken"}} \item{threshold}{numeric, value of threshold} \item{id}{character, id of this step} } The first two types of centroids are in the original units while the last -have been standardized. +has been standardized. } \section{Case weights}{ diff --git a/man/step_corr.Rd b/man/step_corr.Rd index 61e6f1849..ece80c26c 100644 --- a/man/step_corr.Rd +++ b/man/step_corr.Rd @@ -86,7 +86,7 @@ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ -\item{terms}{character, the selectors or variables selected} +\item{terms}{character, the selectors or variables selected to be removed} \item{id}{character, id of this step} } } diff --git a/man/step_hyperbolic.Rd b/man/step_hyperbolic.Rd index aa45b6d26..47666e5d7 100644 --- a/man/step_hyperbolic.Rd +++ b/man/step_hyperbolic.Rd @@ -61,7 +61,7 @@ columns \code{terms}, \code{inverse}, \code{func} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} \item{inverse}{logical, is the inverse function be used} -\item{func}{character, name of function. "sinh", "cosh", or "tanh"} +\item{func}{character, name of function. \code{"sinh"}, \code{"cosh"}, or \code{"tanh"}} \item{id}{character, id of this step} } } diff --git a/man/step_normalize.Rd b/man/step_normalize.Rd index e5676b37f..81ea9cf20 100644 --- a/man/step_normalize.Rd +++ b/man/step_normalize.Rd @@ -70,8 +70,8 @@ columns \code{terms}, \code{statistic}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} -\item{statistic}{character, name of statistic, mean or sd} -\item{value}{numeric, value statistic} +\item{statistic}{character, name of statistic (\code{"mean"} or \code{"sd"})} +\item{value}{numeric, value of the \code{statistic}} \item{id}{character, id of this step} } } diff --git a/man/step_novel.Rd b/man/step_novel.Rd index 51a9ad558..fd00fd4fa 100644 --- a/man/step_novel.Rd +++ b/man/step_novel.Rd @@ -77,7 +77,7 @@ columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} -\item{value}{character, the factor levels that is used for the new value} +\item{value}{character, the factor levels that are used for the new value} \item{id}{character, id of this step} } } diff --git a/man/step_other.Rd b/man/step_other.Rd index 89ae9eb6f..5d5107e5c 100644 --- a/man/step_other.Rd +++ b/man/step_other.Rd @@ -89,7 +89,7 @@ columns \code{terms}, \code{retained} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} -\item{retained}{character, factor levels not pulled into "other"} +\item{retained}{character, factor levels not pulled into \code{"other"}} \item{id}{character, id of this step} } } diff --git a/man/step_pls.Rd b/man/step_pls.Rd index fa0b3a049..06e85d1f8 100644 --- a/man/step_pls.Rd +++ b/man/step_pls.Rd @@ -112,7 +112,7 @@ columns \code{terms}, \code{value}, \code{component} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} -\item{value}{numeric, coeficients defined as \eqn{W(P'W)^{-1}}} +\item{value}{numeric, coefficients defined as \eqn{W(P'W)^{-1}}} \item{size}{character, name of component} \item{id}{character, id of this step} } diff --git a/man/step_profile.Rd b/man/step_profile.Rd index 07eb5b9d6..23c5422c4 100644 --- a/man/step_profile.Rd +++ b/man/step_profile.Rd @@ -93,7 +93,7 @@ columns \code{terms}, \code{type} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} -\item{type}{character, fixed or profiled} +\item{type}{character, \code{"fixed"} or \code{"profiled"}} \item{id}{character, id of this step} } } From 48a2b4fd801a2b27482ed529357494c5e8c8be51 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Thu, 5 Oct 2023 13:21:11 -0700 Subject: [PATCH 09/12] dont document number of columns --- R/BoxCox.R | 2 +- R/YeoJohnson.R | 2 +- R/arrange.R | 2 +- R/bin2factor.R | 2 +- R/bs.R | 2 +- R/center.R | 2 +- R/classdist.R | 2 +- R/classdist_shrunken.R | 2 +- R/corr.R | 2 +- R/count.R | 2 +- R/cut.R | 2 +- R/date.R | 2 +- R/depth.R | 2 +- R/discretize.R | 2 +- R/dummy.R | 2 +- R/dummy_extract.R | 2 +- R/dummy_multi_choice.R | 2 +- R/factor2string.R | 2 +- R/filter.R | 2 +- R/filter_missing.R | 2 +- R/geodist.R | 2 +- R/harmonic.R | 2 +- R/holiday.R | 2 +- R/hyperbolic.R | 2 +- R/ica.R | 2 +- R/impute_bag.R | 2 +- R/impute_knn.R | 2 +- R/impute_linear.R | 2 +- R/impute_lower.R | 2 +- R/impute_mean.R | 2 +- R/impute_median.R | 2 +- R/impute_mode.R | 2 +- R/impute_roll.R | 2 +- R/indicate_na.R | 2 +- R/integer.R | 2 +- R/interact.R | 2 +- R/intercept.R | 2 +- R/inverse.R | 2 +- R/invlogit.R | 2 +- R/isomap.R | 2 +- R/kpca.R | 2 +- R/kpca_poly.R | 2 +- R/kpca_rbf.R | 2 +- R/lag.R | 2 +- R/lincomb.R | 2 +- R/log.R | 2 +- R/logit.R | 2 +- R/mutate.R | 2 +- R/mutate_at.R | 2 +- R/naomit.R | 2 +- R/nnmf.R | 2 +- R/nnmf_sparse.R | 2 +- R/normalize.R | 2 +- R/novel.R | 2 +- R/ns.R | 2 +- R/num2factor.R | 2 +- R/nzv.R | 2 +- R/ordinalscore.R | 2 +- R/other.R | 2 +- R/percentile.R | 2 +- R/pls.R | 2 +- R/poly.R | 2 +- R/poly_bernstein.R | 2 +- R/profile.R | 2 +- R/range.R | 2 +- R/ratio.R | 2 +- R/regex.R | 2 +- R/relevel.R | 2 +- R/relu.R | 2 +- R/rename.R | 2 +- R/rename_at.R | 2 +- R/rm.R | 2 +- R/sample.R | 2 +- R/scale.R | 2 +- R/select.R | 2 +- R/shuffle.R | 2 +- R/slice.R | 2 +- R/spatialsign.R | 2 +- R/spline_b.R | 2 +- R/spline_convex.R | 2 +- R/spline_monotone.R | 2 +- R/spline_natural.R | 2 +- R/spline_nonnegative.R | 2 +- R/sqrt.R | 2 +- R/string2factor.R | 2 +- R/time.R | 2 +- R/unknown.R | 2 +- R/unorder.R | 2 +- R/window.R | 2 +- R/zv.R | 2 +- man/recipe.Rd | 16 ++++++++-------- man/selections.Rd | 16 ++++++++-------- man/step_BoxCox.Rd | 2 +- man/step_YeoJohnson.Rd | 2 +- man/step_arrange.Rd | 2 +- man/step_bin2factor.Rd | 2 +- man/step_bs.Rd | 2 +- man/step_center.Rd | 2 +- man/step_classdist.Rd | 2 +- man/step_classdist_shrunken.Rd | 2 +- man/step_corr.Rd | 2 +- man/step_count.Rd | 2 +- man/step_cut.Rd | 2 +- man/step_date.Rd | 2 +- man/step_depth.Rd | 2 +- man/step_discretize.Rd | 2 +- man/step_dummy.Rd | 2 +- man/step_dummy_extract.Rd | 2 +- man/step_dummy_multi_choice.Rd | 2 +- man/step_factor2string.Rd | 2 +- man/step_filter.Rd | 2 +- man/step_filter_missing.Rd | 2 +- man/step_geodist.Rd | 2 +- man/step_harmonic.Rd | 2 +- man/step_holiday.Rd | 2 +- man/step_hyperbolic.Rd | 2 +- man/step_ica.Rd | 2 +- man/step_impute_bag.Rd | 2 +- man/step_impute_knn.Rd | 2 +- man/step_impute_linear.Rd | 2 +- man/step_impute_lower.Rd | 2 +- man/step_impute_mean.Rd | 2 +- man/step_impute_median.Rd | 2 +- man/step_impute_mode.Rd | 2 +- man/step_impute_roll.Rd | 2 +- man/step_indicate_na.Rd | 2 +- man/step_integer.Rd | 2 +- man/step_interact.Rd | 2 +- man/step_intercept.Rd | 2 +- man/step_inverse.Rd | 2 +- man/step_invlogit.Rd | 2 +- man/step_isomap.Rd | 2 +- man/step_kpca.Rd | 2 +- man/step_kpca_poly.Rd | 2 +- man/step_kpca_rbf.Rd | 2 +- man/step_lag.Rd | 2 +- man/step_lincomb.Rd | 2 +- man/step_log.Rd | 2 +- man/step_logit.Rd | 2 +- man/step_mutate.Rd | 2 +- man/step_mutate_at.Rd | 2 +- man/step_naomit.Rd | 2 +- man/step_nnmf.Rd | 2 +- man/step_nnmf_sparse.Rd | 2 +- man/step_normalize.Rd | 2 +- man/step_novel.Rd | 2 +- man/step_ns.Rd | 2 +- man/step_num2factor.Rd | 2 +- man/step_nzv.Rd | 2 +- man/step_ordinalscore.Rd | 2 +- man/step_other.Rd | 2 +- man/step_percentile.Rd | 2 +- man/step_pls.Rd | 2 +- man/step_poly.Rd | 2 +- man/step_poly_bernstein.Rd | 2 +- man/step_profile.Rd | 2 +- man/step_range.Rd | 2 +- man/step_ratio.Rd | 2 +- man/step_regex.Rd | 2 +- man/step_relevel.Rd | 2 +- man/step_relu.Rd | 2 +- man/step_rename.Rd | 2 +- man/step_rename_at.Rd | 2 +- man/step_rm.Rd | 2 +- man/step_sample.Rd | 2 +- man/step_scale.Rd | 2 +- man/step_select.Rd | 2 +- man/step_shuffle.Rd | 2 +- man/step_slice.Rd | 2 +- man/step_spatialsign.Rd | 2 +- man/step_spline_b.Rd | 2 +- man/step_spline_convex.Rd | 2 +- man/step_spline_monotone.Rd | 2 +- man/step_spline_natural.Rd | 2 +- man/step_spline_nonnegative.Rd | 2 +- man/step_sqrt.Rd | 2 +- man/step_string2factor.Rd | 2 +- man/step_time.Rd | 2 +- man/step_unknown.Rd | 2 +- man/step_unorder.Rd | 2 +- man/step_window.Rd | 2 +- man/step_zv.Rd | 2 +- 182 files changed, 196 insertions(+), 196 deletions(-) diff --git a/R/BoxCox.R b/R/BoxCox.R index 9937edcd6..a0cfbafd8 100644 --- a/R/BoxCox.R +++ b/R/BoxCox.R @@ -33,7 +33,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/YeoJohnson.R b/R/YeoJohnson.R index 4b510ff0f..0ef5770e9 100644 --- a/R/YeoJohnson.R +++ b/R/YeoJohnson.R @@ -32,7 +32,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/arrange.R b/R/arrange.R index 2c7e3a69e..4aba578cb 100644 --- a/R/arrange.R +++ b/R/arrange.R @@ -17,7 +17,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/bin2factor.R b/R/bin2factor.R index 360d05570..fb82d5388 100644 --- a/R/bin2factor.R +++ b/R/bin2factor.R @@ -21,7 +21,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/bs.R b/R/bs.R index cef7b1c47..97d7bceec 100644 --- a/R/bs.R +++ b/R/bs.R @@ -27,7 +27,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/center.R b/R/center.R index 1a2a1ce06..a6fb93861 100644 --- a/R/center.R +++ b/R/center.R @@ -34,7 +34,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/classdist.R b/R/classdist.R index 215bddb43..eeebc24e7 100644 --- a/R/classdist.R +++ b/R/classdist.R @@ -42,7 +42,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value`, `class` , and `id`: #' #' \describe{ diff --git a/R/classdist_shrunken.R b/R/classdist_shrunken.R index 9cc2cb01d..86e6cdadc 100644 --- a/R/classdist_shrunken.R +++ b/R/classdist_shrunken.R @@ -40,7 +40,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 6 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value`, `class`, `type`, `threshold` , and `id`: #' #' \describe{ diff --git a/R/corr.R b/R/corr.R index c1efe63dc..dc1f4d2be 100644 --- a/R/corr.R +++ b/R/corr.R @@ -39,7 +39,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/count.R b/R/count.R index a5a675edb..432d2b0dd 100644 --- a/R/count.R +++ b/R/count.R @@ -26,7 +26,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `result` , and `id`: #' #' \describe{ diff --git a/R/cut.R b/R/cut.R index 42ee851fa..b347c1df7 100644 --- a/R/cut.R +++ b/R/cut.R @@ -21,7 +21,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/date.R b/R/date.R index eac5232f8..0d356f838 100644 --- a/R/date.R +++ b/R/date.R @@ -50,7 +50,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value`, `ordinal` , and `id`: #' #' \describe{ diff --git a/R/depth.R b/R/depth.R index c0da70b93..5dd81900f 100644 --- a/R/depth.R +++ b/R/depth.R @@ -53,7 +53,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `class` , and `id`: #' #' \describe{ diff --git a/R/discretize.R b/R/discretize.R index 8080dfa81..80f85810d 100644 --- a/R/discretize.R +++ b/R/discretize.R @@ -259,7 +259,7 @@ print.discretize <- #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/dummy.R b/R/dummy.R index 2774fc714..55cd6d400 100644 --- a/R/dummy.R +++ b/R/dummy.R @@ -67,7 +67,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `columns` , and `id`: #' #' \describe{ diff --git a/R/dummy_extract.R b/R/dummy_extract.R index 283733417..031cfbf8c 100644 --- a/R/dummy_extract.R +++ b/R/dummy_extract.R @@ -33,7 +33,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `columns` , and `id`: #' #' \describe{ diff --git a/R/dummy_multi_choice.R b/R/dummy_multi_choice.R index c5ac3d192..e8890b15b 100644 --- a/R/dummy_multi_choice.R +++ b/R/dummy_multi_choice.R @@ -31,7 +31,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `columns` , and `id`: #' #' \describe{ diff --git a/R/factor2string.R b/R/factor2string.R index 73df55820..607888310 100644 --- a/R/factor2string.R +++ b/R/factor2string.R @@ -15,7 +15,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/filter.R b/R/filter.R index 52cc089f3..cec00dbef 100644 --- a/R/filter.R +++ b/R/filter.R @@ -19,7 +19,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/filter_missing.R b/R/filter_missing.R index 799c49563..2e4373010 100644 --- a/R/filter_missing.R +++ b/R/filter_missing.R @@ -22,7 +22,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/geodist.R b/R/geodist.R index e05b2316a..1e2169ee7 100644 --- a/R/geodist.R +++ b/R/geodist.R @@ -28,7 +28,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 7 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `latitude`, `longitude`, `ref_latitude`, `ref_longitude`, #' `is_lat_lon`, `name` , and `id`: #' diff --git a/R/harmonic.R b/R/harmonic.R index eabc373b5..175f20866 100644 --- a/R/harmonic.R +++ b/R/harmonic.R @@ -66,7 +66,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 6 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `starting_val`, `cycle_size`, `frequency`, `key` , and `id`: #' #' \describe{ diff --git a/R/holiday.R b/R/holiday.R index 979ee99b1..ef00c0bd5 100644 --- a/R/holiday.R +++ b/R/holiday.R @@ -19,7 +19,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `holiday` , and `id`: #' #' \describe{ diff --git a/R/hyperbolic.R b/R/hyperbolic.R index 83df31946..88f9655e8 100644 --- a/R/hyperbolic.R +++ b/R/hyperbolic.R @@ -15,7 +15,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `inverse`, `func` , and `id`: #' #' \describe{ diff --git a/R/ica.R b/R/ica.R index 5292c60b6..2dac2c5e6 100644 --- a/R/ica.R +++ b/R/ica.R @@ -41,7 +41,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `component`, `value` , and `id`: #' #' \describe{ diff --git a/R/impute_bag.R b/R/impute_bag.R index e0a562cb4..46ce60ca2 100644 --- a/R/impute_bag.R +++ b/R/impute_bag.R @@ -49,7 +49,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `model` , and `id`: #' #' \describe{ diff --git a/R/impute_knn.R b/R/impute_knn.R index 038195d2e..7ed43bc9f 100644 --- a/R/impute_knn.R +++ b/R/impute_knn.R @@ -34,7 +34,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `predictors`, `neighbors` , and `id`: #' #' \describe{ diff --git a/R/impute_linear.R b/R/impute_linear.R index 9fa6dfc66..2b68497b0 100644 --- a/R/impute_linear.R +++ b/R/impute_linear.R @@ -28,7 +28,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `model` , and `id`: #' #' \describe{ diff --git a/R/impute_lower.R b/R/impute_lower.R index 903e88b93..2d709cf05 100644 --- a/R/impute_lower.R +++ b/R/impute_lower.R @@ -22,7 +22,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/impute_mean.R b/R/impute_mean.R index 3e4e6436f..30324fd05 100644 --- a/R/impute_mean.R +++ b/R/impute_mean.R @@ -23,7 +23,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `model` , and `id`: #' #' \describe{ diff --git a/R/impute_median.R b/R/impute_median.R index ee6b1d91d..6b09b47e1 100644 --- a/R/impute_median.R +++ b/R/impute_median.R @@ -20,7 +20,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `model` , and `id`: #' #' \describe{ diff --git a/R/impute_mode.R b/R/impute_mode.R index 49a211c24..02a037315 100644 --- a/R/impute_mode.R +++ b/R/impute_mode.R @@ -23,7 +23,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/impute_roll.R b/R/impute_roll.R index ecec163b2..107caf52c 100644 --- a/R/impute_roll.R +++ b/R/impute_roll.R @@ -39,7 +39,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `window` , and `id`: #' #' \describe{ diff --git a/R/indicate_na.R b/R/indicate_na.R index 794096d71..5ab272e9c 100644 --- a/R/indicate_na.R +++ b/R/indicate_na.R @@ -13,7 +13,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/integer.R b/R/integer.R index 15dab5ea2..04b00f388 100644 --- a/R/integer.R +++ b/R/integer.R @@ -31,7 +31,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/interact.R b/R/interact.R index 03784c3bb..fd7a68e63 100644 --- a/R/interact.R +++ b/R/interact.R @@ -50,7 +50,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/intercept.R b/R/intercept.R index d11262063..5b16ffe4e 100644 --- a/R/intercept.R +++ b/R/intercept.R @@ -22,7 +22,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/inverse.R b/R/inverse.R index 4aa2ffddc..883293380 100644 --- a/R/inverse.R +++ b/R/inverse.R @@ -14,7 +14,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/invlogit.R b/R/invlogit.R index 27e1b4ca5..a82d2699f 100644 --- a/R/invlogit.R +++ b/R/invlogit.R @@ -14,7 +14,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/isomap.R b/R/isomap.R index 3e0e638bb..f51422b68 100644 --- a/R/isomap.R +++ b/R/isomap.R @@ -45,7 +45,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` , and `id`: #' #' \describe{ diff --git a/R/kpca.R b/R/kpca.R index ffb166e22..3d44714cd 100644 --- a/R/kpca.R +++ b/R/kpca.R @@ -30,7 +30,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/kpca_poly.R b/R/kpca_poly.R index c3aa33635..24059b945 100644 --- a/R/kpca_poly.R +++ b/R/kpca_poly.R @@ -25,7 +25,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/kpca_rbf.R b/R/kpca_rbf.R index c3339554a..1d7b09ed1 100644 --- a/R/kpca_rbf.R +++ b/R/kpca_rbf.R @@ -25,7 +25,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/lag.R b/R/lag.R index 262555a14..245403303 100644 --- a/R/lag.R +++ b/R/lag.R @@ -18,7 +18,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/lincomb.R b/R/lincomb.R index 90d570cca..3faef702f 100644 --- a/R/lincomb.R +++ b/R/lincomb.R @@ -22,7 +22,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/log.R b/R/log.R index 416172be2..8c357cfc8 100644 --- a/R/log.R +++ b/R/log.R @@ -18,7 +18,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `base` , and `id`: #' #' \describe{ diff --git a/R/logit.R b/R/logit.R index b596923dd..aa98d4938 100644 --- a/R/logit.R +++ b/R/logit.R @@ -16,7 +16,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/mutate.R b/R/mutate.R index ece602865..ba4ef1934 100644 --- a/R/mutate.R +++ b/R/mutate.R @@ -20,7 +20,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/mutate_at.R b/R/mutate_at.R index add0a9f96..8d66c1ebb 100644 --- a/R/mutate_at.R +++ b/R/mutate_at.R @@ -16,7 +16,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/naomit.R b/R/naomit.R index c69da9846..8f5ba4fb7 100644 --- a/R/naomit.R +++ b/R/naomit.R @@ -14,7 +14,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/nnmf.R b/R/nnmf.R index 479acf131..a7719d314 100644 --- a/R/nnmf.R +++ b/R/nnmf.R @@ -39,7 +39,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value`, `component` , and `id`: #' #' \describe{ diff --git a/R/nnmf_sparse.R b/R/nnmf_sparse.R index 699b9b831..1087fcfc8 100644 --- a/R/nnmf_sparse.R +++ b/R/nnmf_sparse.R @@ -31,7 +31,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value`, `component` , and `id`: #' #' \describe{ diff --git a/R/normalize.R b/R/normalize.R index efc8cbf44..f2ee61bad 100644 --- a/R/normalize.R +++ b/R/normalize.R @@ -23,7 +23,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `statistic`, `value` , and `id`: #' #' \describe{ diff --git a/R/novel.R b/R/novel.R index d2eca54db..301acc34d 100644 --- a/R/novel.R +++ b/R/novel.R @@ -33,7 +33,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/ns.R b/R/ns.R index 939e1e873..8480d000e 100644 --- a/R/ns.R +++ b/R/ns.R @@ -26,7 +26,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/num2factor.R b/R/num2factor.R index a13c18455..27942c72b 100644 --- a/R/num2factor.R +++ b/R/num2factor.R @@ -19,7 +19,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `ordered` , and `id`: #' #' \describe{ diff --git a/R/nzv.R b/R/nzv.R index 3c100da17..5f626086d 100644 --- a/R/nzv.R +++ b/R/nzv.R @@ -42,7 +42,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/ordinalscore.R b/R/ordinalscore.R index 85ceea399..ce155b719 100644 --- a/R/ordinalscore.R +++ b/R/ordinalscore.R @@ -20,7 +20,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/other.R b/R/other.R index 39fec0d80..9e98287b2 100644 --- a/R/other.R +++ b/R/other.R @@ -43,7 +43,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `retained` , and `id`: #' #' \describe{ diff --git a/R/percentile.R b/R/percentile.R index 426ab385c..03998fda2 100644 --- a/R/percentile.R +++ b/R/percentile.R @@ -24,7 +24,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value`, `percentile` , and `id`: #' #' \describe{ diff --git a/R/pls.R b/R/pls.R index 3b99ae6a9..e7be28e25 100644 --- a/R/pls.R +++ b/R/pls.R @@ -41,7 +41,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value`, `component` , and `id`: #' #' \describe{ diff --git a/R/poly.R b/R/poly.R index a6cfcdbdd..c89920835 100644 --- a/R/poly.R +++ b/R/poly.R @@ -31,7 +31,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `degree` , and `id`: #' #' \describe{ diff --git a/R/poly_bernstein.R b/R/poly_bernstein.R index e02313a5d..e1e560bc3 100644 --- a/R/poly_bernstein.R +++ b/R/poly_bernstein.R @@ -23,7 +23,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/profile.R b/R/profile.R index e1c99cb00..c017150f6 100644 --- a/R/profile.R +++ b/R/profile.R @@ -38,7 +38,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `type` , and `id`: #' #' \describe{ diff --git a/R/range.R b/R/range.R index e4e02ae3f..67162052a 100644 --- a/R/range.R +++ b/R/range.R @@ -24,7 +24,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `min`, `max` , and `id`: #' #' \describe{ diff --git a/R/ratio.R b/R/ratio.R index 11890a156..e03056bb5 100644 --- a/R/ratio.R +++ b/R/ratio.R @@ -29,7 +29,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `denom` , and `id`: #' #' \describe{ diff --git a/R/regex.R b/R/regex.R index dea38eea5..dd839c1b9 100644 --- a/R/regex.R +++ b/R/regex.R @@ -24,7 +24,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `result` , and `id`: #' #' \describe{ diff --git a/R/relevel.R b/R/relevel.R index 74c92d678..fc893f37a 100644 --- a/R/relevel.R +++ b/R/relevel.R @@ -24,7 +24,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/relu.R b/R/relu.R index 2eb18593d..b1cbf2c47 100644 --- a/R/relu.R +++ b/R/relu.R @@ -41,7 +41,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `shift`, `reverse` , and `id`: #' #' \describe{ diff --git a/R/rename.R b/R/rename.R index c5b7d0e89..516c7fc58 100644 --- a/R/rename.R +++ b/R/rename.R @@ -16,7 +16,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/rename_at.R b/R/rename_at.R index b242dece1..99a957254 100644 --- a/R/rename_at.R +++ b/R/rename_at.R @@ -15,7 +15,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/rm.R b/R/rm.R index a2dd40926..fcb0b0597 100644 --- a/R/rm.R +++ b/R/rm.R @@ -13,7 +13,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/sample.R b/R/sample.R index 1e895ecb5..132b1a63c 100644 --- a/R/sample.R +++ b/R/sample.R @@ -18,7 +18,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `size`, `replace` , and `id`: #' #' \describe{ diff --git a/R/scale.R b/R/scale.R index 012319385..40684dd21 100644 --- a/R/scale.R +++ b/R/scale.R @@ -25,7 +25,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/select.R b/R/select.R index 44638109c..80bf700ce 100644 --- a/R/select.R +++ b/R/select.R @@ -15,7 +15,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/shuffle.R b/R/shuffle.R index 13402204b..ba9c3334c 100644 --- a/R/shuffle.R +++ b/R/shuffle.R @@ -10,7 +10,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/slice.R b/R/slice.R index da526524a..93909cac4 100644 --- a/R/slice.R +++ b/R/slice.R @@ -17,7 +17,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/spatialsign.R b/R/spatialsign.R index 941ad6671..91ed4163f 100644 --- a/R/spatialsign.R +++ b/R/spatialsign.R @@ -20,7 +20,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/spline_b.R b/R/spline_b.R index 163923e90..1baec1f9b 100644 --- a/R/spline_b.R +++ b/R/spline_b.R @@ -37,7 +37,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/spline_convex.R b/R/spline_convex.R index 95b7d2c85..c5514f2d8 100644 --- a/R/spline_convex.R +++ b/R/spline_convex.R @@ -28,7 +28,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/spline_monotone.R b/R/spline_monotone.R index 0d9a316b6..c3c0369ef 100644 --- a/R/spline_monotone.R +++ b/R/spline_monotone.R @@ -29,7 +29,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/spline_natural.R b/R/spline_natural.R index 10bb42cc4..fd7496e3e 100644 --- a/R/spline_natural.R +++ b/R/spline_natural.R @@ -27,7 +27,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/spline_nonnegative.R b/R/spline_nonnegative.R index bcc804f89..e0bf68392 100644 --- a/R/spline_nonnegative.R +++ b/R/spline_nonnegative.R @@ -32,7 +32,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/sqrt.R b/R/sqrt.R index a04b50a80..6930cdbf5 100644 --- a/R/sqrt.R +++ b/R/sqrt.R @@ -11,7 +11,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/string2factor.R b/R/string2factor.R index dc421e774..2c01ea5d8 100644 --- a/R/string2factor.R +++ b/R/string2factor.R @@ -46,7 +46,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `ordered` , and `id`: #' #' \describe{ diff --git a/R/time.R b/R/time.R index b0082cec4..597d16d6e 100644 --- a/R/time.R +++ b/R/time.R @@ -30,7 +30,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/unknown.R b/R/unknown.R index 30c23b48f..8ac4f4c59 100644 --- a/R/unknown.R +++ b/R/unknown.R @@ -24,7 +24,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 3 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `value` , and `id`: #' #' \describe{ diff --git a/R/unorder.R b/R/unorder.R index 716a6727c..4b43a1850 100644 --- a/R/unorder.R +++ b/R/unorder.R @@ -12,7 +12,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/R/window.R b/R/window.R index 4880d3e3a..cc864fcb5 100644 --- a/R/window.R +++ b/R/window.R @@ -44,7 +44,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 4 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms`, `statistic`, `size` , and `id`: #' #' \describe{ diff --git a/R/zv.R b/R/zv.R index 5f93e163f..3750f3aac 100644 --- a/R/zv.R +++ b/R/zv.R @@ -18,7 +18,7 @@ #' #' # Tidying #' -#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with 2 +#' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with #' columns `terms` and `id`: #' #' \describe{ diff --git a/man/recipe.Rd b/man/recipe.Rd index 09c6b064f..7d294c445 100644 --- a/man/recipe.Rd +++ b/man/recipe.Rd @@ -80,8 +80,8 @@ added to a recipe. \itemize{ \item \strong{Steps} can include operations like scaling a variable, creating dummy variables or interactions, and so on. More computationally -complex actions such as dimension reduction or imputation can also be -specified. +complex actions such as dimension reduction or imputation can also +be specified. \item \strong{Checks} are operations that conduct specific tests of the data. When the test is satisfied, the data are returned without issue or modification. Otherwise, an error is thrown. @@ -300,12 +300,12 @@ applies the estimated steps to any data set. \if{html}{\out{
}}\preformatted{## # A tibble: 6 x 6 ## HHV PC1 PC2 PC3 PC4 PC5 ## -## 1 18.3 0.730 -0.412 -0.495 0.333 0.253 -## 2 17.6 0.617 1.41 0.118 -0.466 0.815 -## 3 17.2 0.761 1.10 -0.0550 -0.397 0.747 -## 4 18.9 0.0400 0.950 0.158 0.405 -0.143 -## 5 20.5 0.792 -0.732 0.204 0.465 -0.148 -## 6 18.5 0.433 -0.127 -0.354 -0.0168 -0.0888 +## 1 18.3 0.730 0.412 0.495 0.333 0.253 +## 2 17.6 0.617 -1.41 -0.118 -0.466 0.815 +## 3 17.2 0.761 -1.10 0.0550 -0.397 0.747 +## 4 18.9 0.0400 -0.950 -0.158 0.405 -0.143 +## 5 20.5 0.792 0.732 -0.204 0.465 -0.148 +## 6 18.5 0.433 0.127 0.354 -0.0168 -0.0888 }\if{html}{\out{
}} In general, the workflow interface to recipes is recommended for most diff --git a/man/selections.Rd b/man/selections.Rd index 80f1c21a1..cfbe6b5d1 100644 --- a/man/selections.Rd +++ b/man/selections.Rd @@ -111,20 +111,20 @@ will not work. When creating variable selections: \itemize{ -\item If you are using column filtering steps, such as \code{step_corr()}, try to -avoid hardcoding specific variable names in downstream steps in case -those columns are removed by the filter. Instead, use +\item If you are using column filtering steps, such as \code{step_corr()}, try +to avoid hardcoding specific variable names in downstream steps in +case those columns are removed by the filter. Instead, use \code{\link[dplyr:reexports]{dplyr::any_of()}} and \code{\link[dplyr:reexports]{dplyr::all_of()}}. \itemize{ -\item \code{\link[dplyr:reexports]{dplyr::any_of()}} will be tolerant if a column -has been removed. +\item \code{\link[dplyr:reexports]{dplyr::any_of()}} will be tolerant if a +column has been removed. \item \code{\link[dplyr:reexports]{dplyr::all_of()}} will fail unless all of the columns are present in the data. } -\item For both of these functions, if you are going to save the recipe as a -binary object to use in another R session, try to avoid referring to a -vector in your workspace. +\item For both of these functions, if you are going to save the recipe as +a binary object to use in another R session, try to avoid referring +to a vector in your workspace. \itemize{ \item Preferred: \code{any_of(!!var_names)} \item Avoid: \code{any_of(var_names)} diff --git a/man/step_BoxCox.Rd b/man/step_BoxCox.Rd index 7d37b8042..08e7e398f 100644 --- a/man/step_BoxCox.Rd +++ b/man/step_BoxCox.Rd @@ -75,7 +75,7 @@ closed to the bounds, or if the optimization fails, a value of \code{NA} is used and no transformation is applied. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_YeoJohnson.Rd b/man/step_YeoJohnson.Rd index 45699440e..5a7a5d8a3 100644 --- a/man/step_YeoJohnson.Rd +++ b/man/step_YeoJohnson.Rd @@ -78,7 +78,7 @@ closed to the bounds, or if the optimization fails, a value of \code{NA} is used and no transformation is applied. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_arrange.Rd b/man/step_arrange.Rd index 4977422b5..a9faf6751 100644 --- a/man/step_arrange.Rd +++ b/man/step_arrange.Rd @@ -55,7 +55,7 @@ to embed the value of the object in the expression (to be portable between sessions). See the examples. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_bin2factor.Rd b/man/step_bin2factor.Rd index 2507cc179..a02dd31f2 100644 --- a/man/step_bin2factor.Rd +++ b/man/step_bin2factor.Rd @@ -66,7 +66,7 @@ density of numeric binary data. Note that the numeric data is only verified to be numeric (and does not count levels). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_bs.Rd b/man/step_bs.Rd index 5fe6dfa75..934e6849a 100644 --- a/man/step_bs.Rd +++ b/man/step_bs.Rd @@ -75,7 +75,7 @@ from the data and new columns are added. The naming convention for the new variables is \code{varname_bs_1} and so on. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_center.Rd b/man/step_center.Rd index bf1097b73..5f4714432 100644 --- a/man/step_center.Rd +++ b/man/step_center.Rd @@ -59,7 +59,7 @@ argument of \code{prep.recipe}. \code{bake.recipe} then applies the centering to new data sets using these means. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_classdist.Rd b/man/step_classdist.Rd index e5ecf6d88..196312d17 100644 --- a/man/step_classdist.Rd +++ b/man/step_classdist.Rd @@ -98,7 +98,7 @@ there must be at least as many data points are variables overall. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value}, \code{class} , and \code{id}: \describe{ diff --git a/man/step_classdist_shrunken.Rd b/man/step_classdist_shrunken.Rd index 9d8048ac3..18a91574d 100644 --- a/man/step_classdist_shrunken.Rd +++ b/man/step_classdist_shrunken.Rd @@ -97,7 +97,7 @@ values and, by default, have the prefix \code{classdist_}. The naming format can be changed using the \code{prefix} argument. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 6 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value}, \code{class}, \code{type}, \code{threshold} , and \code{id}: \describe{ diff --git a/man/step_corr.Rd b/man/step_corr.Rd index ece80c26c..2c31a7ca2 100644 --- a/man/step_corr.Rd +++ b/man/step_corr.Rd @@ -82,7 +82,7 @@ The arguments \code{use} and \code{method} don't take effect if case weights are used in the recipe. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_count.Rd b/man/step_count.Rd index 331a1ab57..f9be79b12 100644 --- a/man/step_count.Rd +++ b/man/step_count.Rd @@ -73,7 +73,7 @@ sequence of any existing operations. variable that counts instances of a regular expression pattern in text. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{result} , and \code{id}: \describe{ diff --git a/man/step_cut.Rd b/man/step_cut.Rd index 33c373af5..3a30d6867 100644 --- a/man/step_cut.Rd +++ b/man/step_cut.Rd @@ -61,7 +61,7 @@ points will end up in the last. \code{include.lowest} set to \code{TRUE}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_date.Rd b/man/step_date.Rd index c4e1e1f5f..742446875 100644 --- a/man/step_date.Rd +++ b/man/step_date.Rd @@ -97,7 +97,7 @@ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns \code{terms} (the selectors or variables selected), \code{value} (the feature names), and \code{ordinal} (a logical) is returned. -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value}, \code{ordinal} , and \code{id}: \describe{ diff --git a/man/step_depth.Rd b/man/step_depth.Rd index 9650b3769..3975809be 100644 --- a/man/step_depth.Rd +++ b/man/step_depth.Rd @@ -105,7 +105,7 @@ replace the original values and by default have the prefix \code{depth_}. The naming format can be changed using the \code{prefix} argument. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{class} , and \code{id}: \describe{ diff --git a/man/step_discretize.Rd b/man/step_discretize.Rd index 6149154fb..77a6cda37 100644 --- a/man/step_discretize.Rd +++ b/man/step_discretize.Rd @@ -67,7 +67,7 @@ convert numeric data into a factor with bins having approximately the same number of data points (based on a training set). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_dummy.Rd b/man/step_dummy.Rd index 9c0687a2d..41b8487d7 100644 --- a/man/step_dummy.Rd +++ b/man/step_dummy.Rd @@ -113,7 +113,7 @@ The \href{https://recipes.tidymodels.org/articles/Dummies.html}{package vignette and interactions has more information. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{columns} , and \code{id}: \describe{ diff --git a/man/step_dummy_extract.Rd b/man/step_dummy_extract.Rd index dd5ae0445..86b13d78e 100644 --- a/man/step_dummy_extract.Rd +++ b/man/step_dummy_extract.Rd @@ -97,7 +97,7 @@ the \code{naming} argument; the function \code{\link[=dummy_names]{dummy_names() default. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{columns} , and \code{id}: \describe{ diff --git a/man/step_dummy_multi_choice.Rd b/man/step_dummy_multi_choice.Rd index 10b287222..f4eb9197b 100644 --- a/man/step_dummy_multi_choice.Rd +++ b/man/step_dummy_multi_choice.Rd @@ -99,7 +99,7 @@ This step has 1 tuning parameters: } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{columns} , and \code{id}: \describe{ diff --git a/man/step_factor2string.Rd b/man/step_factor2string.Rd index 6a490928a..0f5f6dfe8 100644 --- a/man/step_factor2string.Rd +++ b/man/step_factor2string.Rd @@ -54,7 +54,7 @@ this step will be converted to factors after all of the steps have been prepped. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_filter.Rd b/man/step_filter.Rd index 6343612bb..e1431ad66 100644 --- a/man/step_filter.Rd +++ b/man/step_filter.Rd @@ -67,7 +67,7 @@ before starting a preprocessing \code{\link[=recipe]{recipe()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_filter_missing.Rd b/man/step_filter_missing.Rd index 71ebb4469..c1af61b5b 100644 --- a/man/step_filter_missing.Rd +++ b/man/step_filter_missing.Rd @@ -65,7 +65,7 @@ values exceeds the \code{threshold}. All variables with missing values will be removed for \code{threshold = 0}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_geodist.Rd b/man/step_geodist.Rd index 0220f8e67..e21ab01c7 100644 --- a/man/step_geodist.Rd +++ b/man/step_geodist.Rd @@ -79,7 +79,7 @@ distances if \code{is_lat_lon} is FALSE. If \code{is_lat_lon} is TRUE, the Haver formula is used to calculate the great-circle distance in meters. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 7 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{latitude}, \code{longitude}, \code{ref_latitude}, \code{ref_longitude}, \code{is_lat_lon}, \code{name} , and \code{id}: diff --git a/man/step_harmonic.Rd b/man/step_harmonic.Rd index 748a5aa5f..c0c59238e 100644 --- a/man/step_harmonic.Rd +++ b/man/step_harmonic.Rd @@ -113,7 +113,7 @@ This step has 1 tuning parameters: } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 6 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{starting_val}, \code{cycle_size}, \code{frequency}, \code{key} , and \code{id}: \describe{ diff --git a/man/step_holiday.Rd b/man/step_holiday.Rd index 9ebe5225a..dccea8f3a 100644 --- a/man/step_holiday.Rd +++ b/man/step_holiday.Rd @@ -64,7 +64,7 @@ remove the original date variables by default. Set \code{keep_original_cols} to \code{FALSE} to remove them. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{holiday} , and \code{id}: \describe{ diff --git a/man/step_hyperbolic.Rd b/man/step_hyperbolic.Rd index 47666e5d7..de17e3fbb 100644 --- a/man/step_hyperbolic.Rd +++ b/man/step_hyperbolic.Rd @@ -55,7 +55,7 @@ sequence of any existing operations. transform data using a hyperbolic function. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{inverse}, \code{func} , and \code{id}: \describe{ diff --git a/man/step_ica.Rd b/man/step_ica.Rd index 109643b7d..1816973ed 100644 --- a/man/step_ica.Rd +++ b/man/step_ica.Rd @@ -103,7 +103,7 @@ sequence of numbers. The variable names are padded with zeros. For example, if the names would be \code{IC1} - \code{IC101}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{component}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_impute_bag.Rd b/man/step_impute_bag.Rd index 589b92f81..1691903b5 100644 --- a/man/step_impute_bag.Rd +++ b/man/step_impute_bag.Rd @@ -109,7 +109,7 @@ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns \code{terms} (the selectors or variables selected) and \code{model} (the bagged tree object) is returned. -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{model} , and \code{id}: \describe{ diff --git a/man/step_impute_knn.Rd b/man/step_impute_knn.Rd index 1a9747120..1c2a46ef8 100644 --- a/man/step_impute_knn.Rd +++ b/man/step_impute_knn.Rd @@ -102,7 +102,7 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_knnimput to \code{step_impute_knn()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{predictors}, \code{neighbors} , and \code{id}: \describe{ diff --git a/man/step_impute_linear.Rd b/man/step_impute_linear.Rd index 125289415..1e3dd9c45 100644 --- a/man/step_impute_linear.Rd +++ b/man/step_impute_linear.Rd @@ -70,7 +70,7 @@ Since this is a linear regression, the imputation model only uses complete cases for the training set predictors. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{model} , and \code{id}: \describe{ diff --git a/man/step_impute_lower.Rd b/man/step_impute_lower.Rd index e96bb2e94..20cefb661 100644 --- a/man/step_impute_lower.Rd +++ b/man/step_impute_lower.Rd @@ -71,7 +71,7 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_lowerimp to \code{step_impute_lower()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_impute_mean.Rd b/man/step_impute_mean.Rd index e5954e915..4a501fb7c 100644 --- a/man/step_impute_mean.Rd +++ b/man/step_impute_mean.Rd @@ -75,7 +75,7 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_meanimpu to \code{step_impute_mean()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{model} , and \code{id}: \describe{ diff --git a/man/step_impute_median.Rd b/man/step_impute_median.Rd index 8a05ccf68..019909e35 100644 --- a/man/step_impute_median.Rd +++ b/man/step_impute_median.Rd @@ -69,7 +69,7 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_medianimpute()} to \code{step_impute_median()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{model} , and \code{id}: \describe{ diff --git a/man/step_impute_mode.Rd b/man/step_impute_mode.Rd index 635173d49..b80b83809 100644 --- a/man/step_impute_mode.Rd +++ b/man/step_impute_mode.Rd @@ -75,7 +75,7 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_modeimpu to \code{step_impute_mode()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_impute_roll.Rd b/man/step_impute_roll.Rd index 49223d860..41407e9fc 100644 --- a/man/step_impute_roll.Rd +++ b/man/step_impute_roll.Rd @@ -92,7 +92,7 @@ As of \code{recipes} 0.1.16, this function name changed from \code{step_rollimpu to \code{step_impute_roll()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{window} , and \code{id}: \describe{ diff --git a/man/step_indicate_na.Rd b/man/step_indicate_na.Rd index 69fa4ae86..80af6f358 100644 --- a/man/step_indicate_na.Rd +++ b/man/step_indicate_na.Rd @@ -58,7 +58,7 @@ create and append additional binary columns to the data set to indicate which observations are missing. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_integer.Rd b/man/step_integer.Rd index 6bb202949..fb7e14519 100644 --- a/man/step_integer.Rd +++ b/man/step_integer.Rd @@ -73,7 +73,7 @@ Despite the name, the new values are returned as numeric unless \code{strict = TRUE}, which will coerce the results to integers. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_interact.Rd b/man/step_interact.Rd index a0f54ee58..65d691ec8 100644 --- a/man/step_interact.Rd +++ b/man/step_interact.Rd @@ -93,7 +93,7 @@ so that the formula is now \code{(x_2 + x_3 + x_4 + x_5 + x_6):z} and all two-way interactions are created. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_intercept.Rd b/man/step_intercept.Rd index a9291759a..4003413fd 100644 --- a/man/step_intercept.Rd +++ b/man/step_intercept.Rd @@ -55,7 +55,7 @@ only called in the bake step. Be careful to avoid unintentional transformations when calling steps with \code{all_predictors()}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_inverse.Rd b/man/step_inverse.Rd index e38902a34..3378045b4 100644 --- a/man/step_inverse.Rd +++ b/man/step_inverse.Rd @@ -52,7 +52,7 @@ sequence of any existing operations. transform the data. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_invlogit.Rd b/man/step_invlogit.Rd index 2f0aa195f..03d9123d5 100644 --- a/man/step_invlogit.Rd +++ b/man/step_invlogit.Rd @@ -53,7 +53,7 @@ real line and translates them to be between zero and one using the function \code{f(x) = 1/(1+exp(-x))}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_isomap.Rd b/man/step_isomap.Rd index 1a83470c1..aa79ee08f 100644 --- a/man/step_isomap.Rd +++ b/man/step_isomap.Rd @@ -100,7 +100,7 @@ if \code{num_terms < 10}, their names will be \code{Isomap1} - \code{Isomap001} - \code{Isomap101}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} , and \code{id}: \describe{ diff --git a/man/step_kpca.Rd b/man/step_kpca.Rd index a3af87c57..c2b610fd2 100644 --- a/man/step_kpca.Rd +++ b/man/step_kpca.Rd @@ -111,7 +111,7 @@ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with column } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_kpca_poly.Rd b/man/step_kpca_poly.Rd index 94ff64916..8ccc5beda 100644 --- a/man/step_kpca_poly.Rd +++ b/man/step_kpca_poly.Rd @@ -113,7 +113,7 @@ This step has 4 tuning parameters: } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_kpca_rbf.Rd b/man/step_kpca_rbf.Rd index 54ca6c0f2..439338ba9 100644 --- a/man/step_kpca_rbf.Rd +++ b/man/step_kpca_rbf.Rd @@ -109,7 +109,7 @@ This step has 2 tuning parameters: } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_lag.Rd b/man/step_lag.Rd index b8a71f2c8..86fb226b5 100644 --- a/man/step_lag.Rd +++ b/man/step_lag.Rd @@ -70,7 +70,7 @@ The step assumes that the data are already \emph{in the proper sequential order} for lagging. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_lincomb.Rd b/man/step_lincomb.Rd index f5c2121b1..37aed619f 100644 --- a/man/step_lincomb.Rd +++ b/man/step_lincomb.Rd @@ -64,7 +64,7 @@ removed to resolve the issue. This algorithm may need to be applied multiple times (as defined by \code{max_steps}). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_log.Rd b/man/step_log.Rd index fbb392329..055169d56 100644 --- a/man/step_log.Rd +++ b/man/step_log.Rd @@ -60,7 +60,7 @@ sequence of any existing operations. transform data. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{base} , and \code{id}: \describe{ diff --git a/man/step_logit.Rd b/man/step_logit.Rd index 3b23d1c3f..ff86353f4 100644 --- a/man/step_logit.Rd +++ b/man/step_logit.Rd @@ -57,7 +57,7 @@ zero and one and translates them to be on the real line using the function \code{f(p) = log(p/(1-p))}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_mutate.Rd b/man/step_mutate.Rd index 476efe8c2..c7010ce82 100644 --- a/man/step_mutate.Rd +++ b/man/step_mutate.Rd @@ -62,7 +62,7 @@ If a preceding step removes a column that is selected by name in \code{step_mutate()}, the recipe will error when being estimated with \code{\link[=prep]{prep()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_mutate_at.Rd b/man/step_mutate_at.Rd index 629acb3b5..b4cfaa38b 100644 --- a/man/step_mutate_at.Rd +++ b/man/step_mutate_at.Rd @@ -60,7 +60,7 @@ When applied to new data or testing data, this transformation would use the mean of \code{w} from the \emph{new} data, not the mean of \code{w} from the training data. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_naomit.Rd b/man/step_naomit.Rd index 4476b0930..2bb422616 100644 --- a/man/step_naomit.Rd +++ b/man/step_naomit.Rd @@ -58,7 +58,7 @@ before starting a preprocessing \code{\link[=recipe]{recipe()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_nnmf.Rd b/man/step_nnmf.Rd index b98eaafeb..6d580ede6 100644 --- a/man/step_nnmf.Rd +++ b/man/step_nnmf.Rd @@ -99,7 +99,7 @@ sequence of numbers. The variable names are padded with zeros. For example, if the names would be \code{NNMF1} - \code{NNMF101}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value}, \code{component} , and \code{id}: \describe{ diff --git a/man/step_nnmf_sparse.Rd b/man/step_nnmf_sparse.Rd index 326d8f0a3..06ab7910b 100644 --- a/man/step_nnmf_sparse.Rd +++ b/man/step_nnmf_sparse.Rd @@ -91,7 +91,7 @@ sequence of numbers. The variable names are padded with zeros. For example, if the names would be \code{NNMF1} - \code{NNMF101}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value}, \code{component} , and \code{id}: \describe{ diff --git a/man/step_normalize.Rd b/man/step_normalize.Rd index 81ea9cf20..31df7c271 100644 --- a/man/step_normalize.Rd +++ b/man/step_normalize.Rd @@ -65,7 +65,7 @@ deviations and means from the data used in the \code{training} argument of these estimates. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{statistic}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_novel.Rd b/man/step_novel.Rd index fd00fd4fa..31bd5d92a 100644 --- a/man/step_novel.Rd +++ b/man/step_novel.Rd @@ -72,7 +72,7 @@ When fitting a model that can deal with new factor levels, consider using new levels at prediction time, instead of throwing warnings or errors. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_ns.Rd b/man/step_ns.Rd index 1d1890087..f4a56f201 100644 --- a/man/step_ns.Rd +++ b/man/step_ns.Rd @@ -72,7 +72,7 @@ from the data and new columns are added. The naming convention for the new variables is \code{varname_ns_1} and so on. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_num2factor.Rd b/man/step_num2factor.Rd index b4aa0168d..495ff12c8 100644 --- a/man/step_num2factor.Rd +++ b/man/step_num2factor.Rd @@ -60,7 +60,7 @@ sequence of any existing operations. integers. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{ordered} , and \code{id}: \describe{ diff --git a/man/step_nzv.Rd b/man/step_nzv.Rd index 42af14581..d2238e32d 100644 --- a/man/step_nzv.Rd +++ b/man/step_nzv.Rd @@ -88,7 +88,7 @@ In the above example, the frequency ratio is 999 and the unique value percent is 0.2\%. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_ordinalscore.Rd b/man/step_ordinalscore.Rd index f65ada141..d930f7adf 100644 --- a/man/step_ordinalscore.Rd +++ b/man/step_ordinalscore.Rd @@ -61,7 +61,7 @@ a linear scale (1, 2, 3, ... \code{C}) but custom score functions can also be used (see the example below). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_other.Rd b/man/step_other.Rd index 5d5107e5c..4ff1ed897 100644 --- a/man/step_other.Rd +++ b/man/step_other.Rd @@ -84,7 +84,7 @@ When data to be processed contains novel levels (i.e., not contained in the training set), the other category is assigned. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{retained} , and \code{id}: \describe{ diff --git a/man/step_percentile.Rd b/man/step_percentile.Rd index 25243f2b6..8721886b1 100644 --- a/man/step_percentile.Rd +++ b/man/step_percentile.Rd @@ -61,7 +61,7 @@ sequence of any existing operations. the value of a variable with its percentile from the training set. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value}, \code{percentile} , and \code{id}: \describe{ diff --git a/man/step_pls.Rd b/man/step_pls.Rd index 06e85d1f8..68e89fbb9 100644 --- a/man/step_pls.Rd +++ b/man/step_pls.Rd @@ -107,7 +107,7 @@ proportion to determine the \code{keepX} parameter in \code{mixOmics::spls()} an \code{mixOmics::splsda()}. See the references in \code{mixOmics::spls()} for details. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value}, \code{component} , and \code{id}: \describe{ diff --git a/man/step_poly.Rd b/man/step_poly.Rd index f510b82a1..0294e8282 100644 --- a/man/step_poly.Rd +++ b/man/step_poly.Rd @@ -75,7 +75,7 @@ otherwise be a problem for large values of \code{degree}. Orthogonal polynomial expansion pick up the same signal as their uncorrelated counterpart. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{degree} , and \code{id}: \describe{ diff --git a/man/step_poly_bernstein.Rd b/man/step_poly_bernstein.Rd index 2c81ebee4..708f9b097 100644 --- a/man/step_poly_bernstein.Rd +++ b/man/step_poly_bernstein.Rd @@ -75,7 +75,7 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_profile.Rd b/man/step_profile.Rd index 23c5422c4..ed93d4c10 100644 --- a/man/step_profile.Rd +++ b/man/step_profile.Rd @@ -88,7 +88,7 @@ This step is atypical in that, when baked, the based on the fixed and profiled variable's information. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{type} , and \code{id}: \describe{ diff --git a/man/step_range.Rd b/man/step_range.Rd index b20a6ef95..5e41a7bc1 100644 --- a/man/step_range.Rd +++ b/man/step_range.Rd @@ -68,7 +68,7 @@ the training set, the new values are truncated at \code{min} or \code{max}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{min}, \code{max} , and \code{id}: \describe{ diff --git a/man/step_ratio.Rd b/man/step_ratio.Rd index f5487718a..27aa0edef 100644 --- a/man/step_ratio.Rd +++ b/man/step_ratio.Rd @@ -76,7 +76,7 @@ one or more ratios from selected numeric variables. When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble with columns \code{terms} (the selectors or variables selected) and \code{denom} is returned. -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{denom} , and \code{id}: \describe{ diff --git a/man/step_regex.Rd b/man/step_regex.Rd index 68f7e0057..5aea2fc0a 100644 --- a/man/step_regex.Rd +++ b/man/step_regex.Rd @@ -69,7 +69,7 @@ sequence of any existing operations. new dummy variable based on a regular expression. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{result} , and \code{id}: \describe{ diff --git a/man/step_relevel.Rd b/man/step_relevel.Rd index 645d33858..d7d8a2bd8 100644 --- a/man/step_relevel.Rd +++ b/man/step_relevel.Rd @@ -62,7 +62,7 @@ Note that if the original columns are character, they will be converted to factors by this step. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_relu.Rd b/man/step_relu.Rd index 3c2ce00ec..9e4ddbfee 100644 --- a/man/step_relu.Rd +++ b/man/step_relu.Rd @@ -85,7 +85,7 @@ residuals only if they are within a certain margin of the decision boundary. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{shift}, \code{reverse} , and \code{id}: \describe{ diff --git a/man/step_rename.Rd b/man/step_rename.Rd index 11e8945cb..80e9440f5 100644 --- a/man/step_rename.Rd +++ b/man/step_rename.Rd @@ -54,7 +54,7 @@ quasiquotation (e.g. \verb{!!}) to embed the value of the object in the expression (to be portable between sessions). } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_rename_at.Rd b/man/step_rename_at.Rd index 6ef0bafa1..b90905442 100644 --- a/man/step_rename_at.Rd +++ b/man/step_rename_at.Rd @@ -54,7 +54,7 @@ rename the selected variables using a common function via \code{\link[dplyr:select_all]{dplyr::rename_at()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_rm.Rd b/man/step_rm.Rd index 63dfa9419..3f1aba33d 100644 --- a/man/step_rm.Rd +++ b/man/step_rm.Rd @@ -55,7 +55,7 @@ specifically referenced by name. To avoid this, see the advice in the \emph{Tips for saving recipes and filtering columns} section of \link{selections}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_sample.Rd b/man/step_sample.Rd index 6743f660c..7766ce6fb 100644 --- a/man/step_sample.Rd +++ b/man/step_sample.Rd @@ -65,7 +65,7 @@ before starting a preprocessing \code{\link[=recipe]{recipe()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{size}, \code{replace} , and \code{id}: \describe{ diff --git a/man/step_scale.Rd b/man/step_scale.Rd index 9ebb5601e..5f8e66d61 100644 --- a/man/step_scale.Rd +++ b/man/step_scale.Rd @@ -67,7 +67,7 @@ the variable standard deviations from the data used in the using these standard deviations. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_select.Rd b/man/step_select.Rd index b61a119b2..c0d0580ac 100644 --- a/man/step_select.Rd +++ b/man/step_select.Rd @@ -56,7 +56,7 @@ specifically referenced by name. To avoid this, see the advice in the \emph{Tips for saving recipes and filtering columns} section of \link{selections}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_shuffle.Rd b/man/step_shuffle.Rd index 4b319c4eb..4b196f604 100644 --- a/man/step_shuffle.Rd +++ b/man/step_shuffle.Rd @@ -48,7 +48,7 @@ sequence of any existing operations. randomly change the order of rows for selected variables. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_slice.Rd b/man/step_slice.Rd index ea1caa481..85ae8e909 100644 --- a/man/step_slice.Rd +++ b/man/step_slice.Rd @@ -65,7 +65,7 @@ before starting a preprocessing \code{\link[=recipe]{recipe()}}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_spatialsign.Rd b/man/step_spatialsign.Rd index 330377ff5..d65858971 100644 --- a/man/step_spatialsign.Rd +++ b/man/step_spatialsign.Rd @@ -62,7 +62,7 @@ The variables should be centered and scaled prior to the computations. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_spline_b.Rd b/man/step_spline_b.Rd index e9e6db08d..607e29b07 100644 --- a/man/step_spline_b.Rd +++ b/man/step_spline_b.Rd @@ -81,7 +81,7 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_spline_convex.Rd b/man/step_spline_convex.Rd index 1cffd4351..c78ad8e84 100644 --- a/man/step_spline_convex.Rd +++ b/man/step_spline_convex.Rd @@ -85,7 +85,7 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_spline_monotone.Rd b/man/step_spline_monotone.Rd index 8301ea72c..4ebbf86de 100644 --- a/man/step_spline_monotone.Rd +++ b/man/step_spline_monotone.Rd @@ -86,7 +86,7 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_spline_natural.Rd b/man/step_spline_natural.Rd index 72c1574b8..8cdc7c8f0 100644 --- a/man/step_spline_natural.Rd +++ b/man/step_spline_natural.Rd @@ -79,7 +79,7 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_spline_nonnegative.Rd b/man/step_spline_nonnegative.Rd index 43c4a5276..ab65d8af3 100644 --- a/man/step_spline_nonnegative.Rd +++ b/man/step_spline_nonnegative.Rd @@ -89,7 +89,7 @@ remove that column's results (but will retain the original data). Use the \code{tidy()} method to determine which columns were used. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_sqrt.Rd b/man/step_sqrt.Rd index 3f2a2ecd3..7e4e25b3f 100644 --- a/man/step_sqrt.Rd +++ b/man/step_sqrt.Rd @@ -48,7 +48,7 @@ sequence of any existing operations. square root transform to the variables. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_string2factor.Rd b/man/step_string2factor.Rd index 8a8789199..77d48e117 100644 --- a/man/step_string2factor.Rd +++ b/man/step_string2factor.Rd @@ -83,7 +83,7 @@ can also take existing factors (but will leave them as-is). } } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{ordered} , and \code{id}: \describe{ diff --git a/man/step_time.Rd b/man/step_time.Rd index 1e3ab2fca..2bf52fae9 100644 --- a/man/step_time.Rd +++ b/man/step_time.Rd @@ -72,7 +72,7 @@ See \code{\link[=step_date]{step_date()}} if you want to calculate features that hours. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_unknown.Rd b/man/step_unknown.Rd index 35a578403..f0f791701 100644 --- a/man/step_unknown.Rd +++ b/man/step_unknown.Rd @@ -63,7 +63,7 @@ If \code{new_level} is already in the data given to \code{prep}, an error is thrown. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 3 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{value} , and \code{id}: \describe{ diff --git a/man/step_unorder.Rd b/man/step_unorder.Rd index 246fe3d4b..87c397279 100644 --- a/man/step_unorder.Rd +++ b/man/step_unorder.Rd @@ -51,7 +51,7 @@ ordered factor variables into unordered factor variables. The factors level order is preserved during the transformation. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ diff --git a/man/step_window.Rd b/man/step_window.Rd index c1c7652c4..f966c2528 100644 --- a/man/step_window.Rd +++ b/man/step_window.Rd @@ -93,7 +93,7 @@ uses \code{median(x[2:6])}. step will stop with a note about installing the package. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 4 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms}, \code{statistic}, \code{size} , and \code{id}: \describe{ diff --git a/man/step_zv.Rd b/man/step_zv.Rd index 72f0f40a6..11f2cb29c 100644 --- a/man/step_zv.Rd +++ b/man/step_zv.Rd @@ -62,7 +62,7 @@ specifically referenced by name. To avoid this, see the advice in the \emph{Tips for saving recipes and filtering columns} section of \link{selections}. } \section{Tidying}{ -When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with 2 +When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ From 3b61af0dc61b2122e402a8c334dd85451565b942 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Thu, 5 Oct 2023 13:29:12 -0700 Subject: [PATCH 10/12] document terms in step_filter --- R/filter.R | 4 +++- man/step_filter.Rd | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/R/filter.R b/R/filter.R index cec00dbef..7c35f73bf 100644 --- a/R/filter.R +++ b/R/filter.R @@ -26,7 +26,9 @@ #' \item{terms}{character, the selectors or variables selected} #' \item{id}{character, id of this step} #' } -#' +#' +#' The expressions in `terms` are text representations and are not parsable. +#' #' @template case-weights-not-supported #' #' @family row operation steps diff --git a/man/step_filter.Rd b/man/step_filter.Rd index e1431ad66..a3c9a0071 100644 --- a/man/step_filter.Rd +++ b/man/step_filter.Rd @@ -74,6 +74,8 @@ columns \code{terms} and \code{id}: \item{terms}{character, the selectors or variables selected} \item{id}{character, id of this step} } + +The expressions in \code{terms} are text representations and are not parsable. } \section{Case weights}{ From e5d534070f7bb5fd23d2e625df5467901b7123a5 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Thu, 5 Oct 2023 13:31:33 -0700 Subject: [PATCH 11/12] Apply suggestions from code review Co-authored-by: Simon P. Couch --- R/center.R | 2 +- R/dummy_extract.R | 2 ++ R/impute_mean.R | 4 ++-- R/impute_median.R | 4 ++-- R/relevel.R | 2 +- R/slice.R | 2 +- R/tidy.R | 4 ++-- 7 files changed, 11 insertions(+), 9 deletions(-) diff --git a/R/center.R b/R/center.R index a6fb93861..9c6178072 100644 --- a/R/center.R +++ b/R/center.R @@ -35,7 +35,7 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with -#' columns `terms`, `value` , and `id`: +#' columns `terms`, `value`, and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} diff --git a/R/dummy_extract.R b/R/dummy_extract.R index 031cfbf8c..6b2b9c29a 100644 --- a/R/dummy_extract.R +++ b/R/dummy_extract.R @@ -41,6 +41,8 @@ #' \item{columns}{character, names of resulting columns} #' \item{id}{character, id of this step} #' } +#' +#' The return value is ordered according to the frequency of `columns` entries in the training data set. #' #' @template case-weights-unsupervised #' diff --git a/R/impute_mean.R b/R/impute_mean.R index 30324fd05..bdafa11bb 100644 --- a/R/impute_mean.R +++ b/R/impute_mean.R @@ -24,11 +24,11 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with -#' columns `terms`, `model` , and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} -#' \item{model}{numeric, the mean value} +#' \item{value}{numeric, the mean value} #' \item{id}{character, id of this step} #' } #' diff --git a/R/impute_median.R b/R/impute_median.R index 6b09b47e1..483667462 100644 --- a/R/impute_median.R +++ b/R/impute_median.R @@ -21,11 +21,11 @@ #' # Tidying #' #' When you [`tidy()`][tidy.recipe()] this step, a tibble is returned with -#' columns `terms`, `model` , and `id`: +#' columns `terms`, `value` , and `id`: #' #' \describe{ #' \item{terms}{character, the selectors or variables selected} -#' \item{model}{numeric, the median value} +#' \item{value}{numeric, the median value} #' \item{id}{character, id of this step} #' } #' diff --git a/R/relevel.R b/R/relevel.R index fc893f37a..13ae3a278 100644 --- a/R/relevel.R +++ b/R/relevel.R @@ -16,7 +16,7 @@ #' @details #' #' The selected variables are releveled to a level -#' (given by `ref_level`). Placing the `ref_level` in the first +#' (given by `ref_level`), placing the `ref_level` in the first #' position. #' #' Note that if the original columns are character, they will be diff --git a/R/slice.R b/R/slice.R index 93909cac4..55eace4b0 100644 --- a/R/slice.R +++ b/R/slice.R @@ -21,7 +21,7 @@ #' columns `terms` and `id`: #' #' \describe{ -#' \item{terms}{character, containing the filtering indexes} +#' \item{terms}{character, containing the filtering indices} #' \item{id}{character, id of this step} #' } #' diff --git a/R/tidy.R b/R/tidy.R index a7280a1d8..27d8f7e9c 100644 --- a/R/tidy.R +++ b/R/tidy.R @@ -7,7 +7,7 @@ #' @name tidy.recipe #' #' @param x A `recipe` object, step, or check (trained or otherwise). -#' @param number An integer or `NA`. If missing , and `id` is not provided, +#' @param number An integer or `NA`. If missing, and `id` is not provided, #' the return value is a list of the operations in the recipe. #' If a number is given, a `tidy` method is executed for that operation #' in the recipe (if it exists). `number` must not be provided if @@ -19,7 +19,7 @@ #' if `number` is. #' @param ... Not currently used. #' @return A tibble with columns that vary depending on what -#' `tidy` method is executed. When `number` , and `id` are `NA`, a +#' `tidy` method is executed. When `number`, and `id` are `NA`, a #' tibble with columns `number` (the operation iteration), #' `operation` (either "step" or "check"), #' `type` (the method, e.g. "nzv", "center"), a logical From f0018883126726c648db2b0a148443d4fbaa2b5b Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Thu, 5 Oct 2023 13:35:25 -0700 Subject: [PATCH 12/12] redocument --- man/step_center.Rd | 2 +- man/step_dummy_extract.Rd | 2 ++ man/step_impute_mean.Rd | 4 ++-- man/step_impute_median.Rd | 4 ++-- man/step_relevel.Rd | 2 +- man/step_slice.Rd | 2 +- man/tidy.recipe.Rd | 4 ++-- 7 files changed, 11 insertions(+), 9 deletions(-) diff --git a/man/step_center.Rd b/man/step_center.Rd index 5f4714432..ff9539811 100644 --- a/man/step_center.Rd +++ b/man/step_center.Rd @@ -60,7 +60,7 @@ the centering to new data sets using these means. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with -columns \code{terms}, \code{value} , and \code{id}: +columns \code{terms}, \code{value}, and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} diff --git a/man/step_dummy_extract.Rd b/man/step_dummy_extract.Rd index 86b13d78e..0c33c37d2 100644 --- a/man/step_dummy_extract.Rd +++ b/man/step_dummy_extract.Rd @@ -105,6 +105,8 @@ columns \code{terms}, \code{columns} , and \code{id}: \item{columns}{character, names of resulting columns} \item{id}{character, id of this step} } + +The return value is ordered according to the frequency of \code{columns} entries in the training data set. } \section{Case weights}{ diff --git a/man/step_impute_mean.Rd b/man/step_impute_mean.Rd index 4a501fb7c..96ba7fe7b 100644 --- a/man/step_impute_mean.Rd +++ b/man/step_impute_mean.Rd @@ -76,11 +76,11 @@ to \code{step_impute_mean()}. } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with -columns \code{terms}, \code{model} , and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} -\item{model}{numeric, the mean value} +\item{value}{numeric, the mean value} \item{id}{character, id of this step} } } diff --git a/man/step_impute_median.Rd b/man/step_impute_median.Rd index 019909e35..246d94584 100644 --- a/man/step_impute_median.Rd +++ b/man/step_impute_median.Rd @@ -70,11 +70,11 @@ As of \code{recipes} 0.1.16, this function name changed from } \section{Tidying}{ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with -columns \code{terms}, \code{model} , and \code{id}: +columns \code{terms}, \code{value} , and \code{id}: \describe{ \item{terms}{character, the selectors or variables selected} -\item{model}{numeric, the median value} +\item{value}{numeric, the median value} \item{id}{character, id of this step} } } diff --git a/man/step_relevel.Rd b/man/step_relevel.Rd index d7d8a2bd8..055acef2c 100644 --- a/man/step_relevel.Rd +++ b/man/step_relevel.Rd @@ -55,7 +55,7 @@ level as the reference. } \details{ The selected variables are releveled to a level -(given by \code{ref_level}). Placing the \code{ref_level} in the first +(given by \code{ref_level}), placing the \code{ref_level} in the first position. Note that if the original columns are character, they will be diff --git a/man/step_slice.Rd b/man/step_slice.Rd index 85ae8e909..e630baeb7 100644 --- a/man/step_slice.Rd +++ b/man/step_slice.Rd @@ -69,7 +69,7 @@ When you \code{\link[=tidy.recipe]{tidy()}} this step, a tibble is returned with columns \code{terms} and \code{id}: \describe{ -\item{terms}{character, containing the filtering indexes} +\item{terms}{character, containing the filtering indices} \item{id}{character, id of this step} } } diff --git a/man/tidy.recipe.Rd b/man/tidy.recipe.Rd index 83ea9f365..154160f0b 100644 --- a/man/tidy.recipe.Rd +++ b/man/tidy.recipe.Rd @@ -328,7 +328,7 @@ component) or \code{"variance"} (how much variance does each component account for).} -\item{number}{An integer or \code{NA}. If missing , and \code{id} is not provided, +\item{number}{An integer or \code{NA}. If missing, and \code{id} is not provided, the return value is a list of the operations in the recipe. If a number is given, a \code{tidy} method is executed for that operation in the recipe (if it exists). \code{number} must not be provided if @@ -342,7 +342,7 @@ if \code{number} is.} } \value{ A tibble with columns that vary depending on what -\code{tidy} method is executed. When \code{number} , and \code{id} are \code{NA}, a +\code{tidy} method is executed. When \code{number}, and \code{id} are \code{NA}, a tibble with columns \code{number} (the operation iteration), \code{operation} (either "step" or "check"), \code{type} (the method, e.g. "nzv", "center"), a logical