have ?tidy.step_* point to step_*

DESCRIPTION

@@ -57,4 +57,4 @@ Config/Needs/website: tidymodels, ggiraph, tidyverse/tidytemplate, reticulate
 Config/testthat/edition: 3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1

NEWS.md

@@ -8,6 +8,8 @@
 
 * Fixed regression from 1.1.2 in `step_lencode_glm()` where it couldn't be used on multiple columns.
 
+* Calling `?tidy.step_*()` now sends you to the documentation for `step_*()` where the outcome is documented. (#216)
+
 # embed 1.1.2
 
 ## Improvements

R/collapse_cart.R

@@ -161,8 +161,8 @@ print.step_collapse_cart <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_collapse_cart` object.
+#' @rdname step_collapse_cart
+#' @usage NULL
 #' @export
 tidy.step_collapse_cart <- function(x, ...) {
   if (is_trained(x)) {

R/collapse_stringdist.R

@@ -207,8 +207,8 @@ print.step_collapse_stringdist <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_collapse_stringdist` object.
+#' @rdname step_collapse_stringdist
+#' @usage NULL
 #' @export
 tidy.step_collapse_stringdist <- function(x, ...) {
   if (is_trained(x)) {

R/discretize_cart.R

@@ -275,8 +275,8 @@ print.step_discretize_cart <- function(x, width = max(20, options()$width - 30),
   invisible(x)
 }
 
-#' @rdname tidy.recipe
-#' @param x A `step_discretize_cart` object.
+#' @rdname step_discretize_cart
+#' @usage NULL
 #' @export
 tidy.step_discretize_cart <- function(x, ...) {
   if (is_trained(x)) {

R/discretize_xgb.R

@@ -509,8 +509,8 @@ print.step_discretize_xgb <- function(x, width = max(20, options()$width - 30),
   invisible(x)
 }
 
-#' @rdname tidy.recipe
-#' @param x A `step_discretize_xgb` object.
+#' @rdname step_discretize_xgb
+#' @usage NULL
 #' @export
 tidy.step_discretize_xgb <- function(x, ...) {
   if (is_trained(x)) {

R/embed.R

@@ -431,8 +431,8 @@ bake.step_embed <- function(object, new_data, ...) {
   new_data
 }
 
-#' @rdname tidy.recipe
-#' @param x A `step_embed` object.
+#' @rdname step_embed
+#' @usage NULL
 #' @export
 tidy.step_embed <- function(x, ...) {
   if (is_trained(x)) {

R/feature_hash.R

@@ -232,8 +232,8 @@ print.step_feature_hash <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_feature_hash` object.
+#' @rdname step_feature_hash
+#' @usage NULL
 #' @export
 tidy.step_feature_hash <- function(x, ...) {
   if (is_trained(x)) {

R/lencode_bayes.R

@@ -267,9 +267,9 @@ print.step_lencode_bayes <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_lencode_bayes` object.
-#' @export
+  #' @rdname step_lencode_bayes
+  #' @usage NULL
+  #' @export
 tidy.step_lencode_bayes <- function(x, ...) {
   if (is_trained(x)) {
     if (length(x$mapping) == 0) {

R/lencode_glm.R

@@ -221,8 +221,8 @@ print.step_lencode_glm <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_lencode_glm` object.
+#' @rdname step_lencode_glm
+#' @usage NULL
 #' @export
 tidy.step_lencode_glm <- function(x, ...) {
   if (is_trained(x)) {

R/lencode_mixed.R

@@ -261,8 +261,8 @@ print.step_lencode_mixed <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_lencode_mixed` object.
+#' @rdname step_lencode_mixed
+#' @usage NULL
 #' @export
 tidy.step_lencode_mixed <- function(x, ...) {
   if (is_trained(x)) {

R/pca_sparse.R

@@ -243,8 +243,8 @@ pca_coefs <- function(x) {
   res
 }
 
-#' @rdname tidy.recipe
-#' @param x A `step_pca_sparse` object.
+#' @rdname step_pca_sparse
+#' @usage NULL
 #' @export
 tidy.step_pca_sparse <- function(x, ...) {
   if (!is_trained(x)) {

R/pca_sparse_bayes.R

@@ -247,8 +247,8 @@ print.step_pca_sparse_bayes <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_pca_sparse_bayes` object.
+#' @rdname step_pca_sparse_bayes
+#' @usage NULL
 #' @export
 tidy.step_pca_sparse_bayes <- function(x, ...) {
   if (!is_trained(x)) {

R/pca_truncated.R

@@ -260,10 +260,8 @@ pca_variances <- function(x) {
   res
 }
 
-#' @rdname tidy.recipe
-#' @param type For `step_pca_truncated`, either `"coef"` (for the variable
-#'   loadings per component) or `"variance"` (how much variance does each
-#'   component account for).
+#' @rdname step_pca_truncated
+#' @usage NULL
 #' @export
 tidy.step_pca_truncated <- function(x, type = "coef", ...) {
   if (!is_trained(x)) {

R/umap.R

@@ -315,8 +315,8 @@ print.step_umap <-
     invisible(x)
   }
 
-#' @rdname tidy.recipe
-#' @param x A `step_umap` object.
+#' @rdname step_umap
+#' @usage NULL
 #' @export
 tidy.step_umap <- function(x, ...) {
   if (is_trained(x)) {

R/woe.R

@@ -486,8 +486,8 @@ print.step_woe <- function(x, width = max(20, options()$width - 29), ...) {
   invisible(x)
 }
 
-#' @rdname tidy.recipe
-#' @param x A `step_woe` object.
+#' @rdname step_woe
+#' @usage NULL
 #' @export
 tidy.step_woe <- function(x, ...) {
   if (is_trained(x)) {

_pkgdown.yml

@@ -41,9 +41,6 @@ reference:
 - title: miscellaneous
   contents:
     - dictionary
-- title: Tidy Methods
-  contents:
-    - tidy.recipe
 
 figures:
   fig.width: 8