Skip to content

Commit 451b4df

Browse files
Merge pull request #1463 from tidymodels/doc-1447
clarify composition argument documentation
2 parents e77616b + 76551c2 commit 451b4df

File tree

3 files changed

+8
-15
lines changed

3 files changed

+8
-15
lines changed

R/recipe.R

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -639,11 +639,12 @@ prep.recipe <-
639639
#' that `prep(retain = TRUE)` was used). See [sparse_data] for more
640640
#' information about use of sparse data.
641641
#' @param composition Either `"tibble"`, `"matrix"`, `"data.frame"`, or
642-
#' `"dgCMatrix"``for the format of the processed data set. Note that all
643-
#' computations during the baking process are done in a non-sparse format.
644-
#' Also, note that this argument should be called **after** any selectors and
645-
#' the selectors should only resolve to numeric columns (otherwise an error is
646-
#' thrown).
642+
#' `"dgCMatrix"``for the format of the processed data set. Also, note that
643+
#' this argument should be called **after** any selectors and the selectors
644+
#' should only resolve to numeric columns if `composition` is set to
645+
#' `"matrix"` or `"dgCMatrix"`. If the data contains sparse columns they will
646+
#' be perseved for `"tibble"` and `"data.frame"`, and efficiently used for
647+
#' `"dgCMatrix"`.
647648
#'
648649
#' @details
649650
#'

man/bake.Rd

Lines changed: 1 addition & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/juice.Rd

Lines changed: 1 addition & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)