-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add supported models and recipes article
- Loading branch information
1 parent
bc50f7e
commit 641868e
Showing
4 changed files
with
59 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,3 +9,4 @@ | |
^_pkgdown\.yml$ | ||
^docs$ | ||
^pkgdown$ | ||
^vignettes/articles$ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
*.html | ||
*.R |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
title: "Supported Models and recipes steps" | ||
--- | ||
|
||
The supported models currently all come from [tidypredict](https://tidypredict.tidymodels.org/) right now. | ||
|
||
## Supported models | ||
|
||
The following models are supported by `tidypredict`: | ||
|
||
- Linear Regression - `lm()` | ||
- Generalized Linear model - `glm()` | ||
- Random Forest models - `randomForest::randomForest()` | ||
- Random Forest models, via `ranger` - `ranger::ranger()` | ||
- MARS models - `earth::earth()` | ||
- XGBoost models - `xgboost::xgb.Booster.complete()` | ||
- Cubist models - `Cubist::cubist()` | ||
- Tree models, via `partykit` - `partykit::ctree()` | ||
|
||
### `parsnip` | ||
|
||
`tidypredict` supports models fitted via the `parsnip` interface. The ones confirmed currently work in `tidypredict` are: | ||
|
||
- `lm()` - `parsnip`: `linear_reg()` with *"lm"* as the engine. | ||
- `randomForest::randomForest()` - `parsnip`: `rand_forest()` with *"randomForest"* as the engine. | ||
- `ranger::ranger()` - `parsnip`: `rand_forest()` with *"ranger"* as the engine. | ||
- `earth::earth()` - `parsnip`: `mars()` with *"earth"* as the engine. | ||
|
||
## Recipes steps | ||
|
||
```{r, include = FALSE} | ||
knitr::opts_chunk$set( | ||
collapse = TRUE, | ||
comment = "#>" | ||
) | ||
``` | ||
|
||
```{r setup} | ||
library(orbital) | ||
``` | ||
|
||
```{r} | ||
#| echo: false | ||
all_funs <- ls(getNamespace("orbital")) | ||
steps <- grep("orbital.step_", all_funs, value = TRUE) | ||
steps <- gsub("orbital.", "", steps) | ||
``` | ||
|
||
The following `r length(steps)` recipes steps are supported | ||
|
||
```{r, results='asis'} | ||
#| echo: false | ||
cat(paste0("- `", steps, "()`\n")) | ||
``` |