note about xrf outcome transformations

tidymodels · May 26, 2020 · 7959c59 · 7959c59
1 parent c2c93f4
commit 7959c59
Show file tree

Hide file tree

Showing 58 changed files with 11,541 additions and 420 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: rules
 Title: Model Wrappers for Rule-Based Models
-Version: 0.0.1
+Version: 0.0.1.9000
 Authors@R: c(
  person(
  given = "Max",

diff --git a/R/rule_fit.R b/R/rule_fit.R
@@ -50,7 +50,10 @@
 #' For the `xrf` engine, the `xgboost` package is used to create the rule set
 #' that is then added to a `glmnet` model.
 #'
-#' The only available engine is `"xrf"`.
+#' The only available engine is `"xrf"`. Not that, per the documentation in
+#' `?xrf`, transformations of the response variable are not supported. To
+#' use these with `rule_fit()`, we recommend using a recipe instead of the
+#' formula method.
 #'
 #' @return An updated `parsnip` model specification.
 #' @seealso [parsnip::fit()], [parsnip::fit_xy()], [xrf::xrf.formula()]

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html
diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html
diff --git a/docs/ISSUE_TEMPLATE.html b/docs/ISSUE_TEMPLATE.html