Built site for AMR@3.0.1.9061: 0c1709c

reference/amr-tidymodels.md

@@ -18,13 +18,64 @@ all_disk()
 
 all_disk_predictors()
 
-step_mic_log2(recipe, ..., role = NA, trained = FALSE, columns = NULL,
-  skip = FALSE, id = recipes::rand_id("mic_log2"))
+step_mic_log2(
+  recipe,
+  ...,
+  role = NA,
+  trained = FALSE,
+  columns = NULL,
+  skip = FALSE,
+  id = recipes::rand_id("mic_log2")
+)
 
-step_sir_numeric(recipe, ..., role = NA, trained = FALSE, columns = NULL,
-  skip = FALSE, id = recipes::rand_id("sir_numeric"))
+step_sir_numeric(
+  recipe,
+  ...,
+  role = NA,
+  trained = FALSE,
+  columns = NULL,
+  skip = FALSE,
+  id = recipes::rand_id("sir_numeric")
+)
 ```
 
+## Arguments
+
+- recipe:
+
+  A recipe object. The step will be added to the sequence of operations
+  for this recipe.
+
+- ...:
+
+  One or more selector functions to choose variables for this step. See
+  [`selections()`](https://recipes.tidymodels.org/reference/selections.html)
+  for more details.
+
+- role:
+
+  Not used by this step since no new variables are created.
+
+- trained:
+
+  A logical to indicate if the quantities for preprocessing have been
+  estimated.
+
+- skip:
+
+  A logical. Should the step be skipped when the recipe is baked by
+  [`bake()`](https://recipes.tidymodels.org/reference/bake.html)? While
+  all operations are baked when
+  [`prep()`](https://recipes.tidymodels.org/reference/prep.html) is run,
+  some operations may not be able to be conducted on new data (e.g.
+  processing the outcome variable(s)). Care should be taken when using
+  `skip = TRUE` as it may affect the computations for subsequent
+  operations.
+
+- id:
+
+  A character string that is unique to this step to identify it.
+
 ## Details
 
 You can read more in our online [AMR with tidymodels
@@ -127,13 +178,13 @@ if (require("tidymodels")) {
 }
 #> Loading required package: tidymodels
 #> ── Attaching packages ────────────────────────────────────── tidymodels 1.5.0 ──
-#> ✔ broom        1.0.12     ✔ rsample      1.3.2 
-#> ✔ dials        1.4.3      ✔ tailor       0.1.0 
+#> ✔ broom        1.0.13     ✔ rsample      1.3.2 
+#> ✔ dials        1.4.4      ✔ tailor       0.1.0 
 #> ✔ infer        1.1.0      ✔ tidyr        1.3.2 
 #> ✔ modeldata    1.5.1      ✔ tune         2.1.0 
-#> ✔ parsnip      1.5.0      ✔ workflows    1.3.0 
+#> ✔ parsnip      1.6.0      ✔ workflows    1.3.0 
 #> ✔ purrr        1.2.2      ✔ workflowsets 1.1.1 
-#> ✔ recipes      1.3.2      ✔ yardstick    1.4.0 
+#> ✔ recipes      1.3.3      ✔ yardstick    1.4.0 
 #> ── Conflicts ───────────────────────────────────────── tidymodels_conflicts() ──
 #> ✖ purrr::discard() masks scales::discard()
 #> ✖ dplyr::filter()  masks stats::filter()