Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix mistake in documented default value of keep_original_cols #1314

Merged
merged 1 commit into from
May 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

* Significant speedup in `step_dummy()` when applied to many columns. (#1305)

* Fixed documentation mistake where default value of `keep_original_cols` argument were wrong. (#1314)

# recipes 1.0.10

## Bug Fixes
Expand Down
2 changes: 2 additions & 0 deletions R/classdist.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
#' the natural log function?
#' @param objects Statistics are stored here once this step has
#' been trained by [prep()].
#' @param keep_original_cols A logical to keep the original variables in the
#' output. Defaults to `TRUE`.
#' @template step-return
#' @family multivariate transformation steps
#' @export
Expand Down
1 change: 1 addition & 0 deletions R/count.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
#' `step_count()` creates a *specification* of a recipe step that will create a
#' variable that counts instances of a regular expression pattern in text.
#'
#' @inheritParams step_classdist
#' @inheritParams step_pca
#' @inheritParams step_center
#' @param ... A single selector function to choose which variable
Expand Down
1 change: 1 addition & 0 deletions R/depth.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
#' numeric data into a measurement of *data depth*. This is done for each value of
#' a categorical class variable.
#'
#' @inheritParams step_classdist
#' @inheritParams step_pca
#' @inheritParams step_center
#' @param class A single character string that specifies a single
Expand Down
1 change: 1 addition & 0 deletions R/geodist.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
#' `step_geodist()` creates a *specification* of a recipe step that will
#' calculate the distance between points on a map to a reference location.
#'
#' @inheritParams step_classdist
#' @inheritParams step_pca
#' @inheritParams step_center
#' @param lon,lat Selector functions to choose which variables are
Expand Down
1 change: 1 addition & 0 deletions R/indicate_na.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
#' create and append additional binary columns to the data set to indicate which
#' observations are missing.
#'
#' @inheritParams step_classdist
#' @inheritParams step_pca
#' @inheritParams step_center
#' @param prefix A character string that will be the prefix to the
Expand Down
1 change: 1 addition & 0 deletions R/interact.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
#' `step_interact()` creates a *specification* of a recipe step that will create
#' new columns that are interaction terms between two or more variables.
#'
#' @inheritParams step_classdist
#' @inheritParams step_pca
#' @inheritParams step_center
#' @param terms A traditional R formula that contains interaction
Expand Down
1 change: 1 addition & 0 deletions R/lag.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
#' the lag was induced. These can be removed with [step_naomit()], or you may
#' specify an alternative filler value with the `default` argument.
#'
#' @inheritParams step_classdist
#' @inheritParams step_pca
#' @inheritParams step_center
#' @param lag A vector of positive integers. Each specified column will be
Expand Down
1 change: 1 addition & 0 deletions R/regex.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
#' `step_regex()` creates a *specification* of a recipe step that will create a
#' new dummy variable based on a regular expression.
#'
#' @inheritParams step_classdist
#' @inheritParams step_pca
#' @inheritParams step_center
#' @param ... A single selector function to choose which variable
Expand Down
1 change: 1 addition & 0 deletions R/window.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
#' new columns that are the results of functions that compute statistics across
#' moving windows.
#'
#' @inheritParams step_classdist
#' @inheritParams step_center
#' @inheritParams step_pca
#' @param role For model terms created by this step, what analysis
Expand Down
2 changes: 1 addition & 1 deletion man/step_classdist.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_classdist_shrunken.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_count.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_depth.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_geodist.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_indicate_na.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_interact.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_lag.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_regex.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/step_window.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading