Add an article with minimal examples #527
Merged
Conversation
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
|
Addresses #519 |
|
I suggest trying to avoid links for function names in the section headings. It is easy to click on those when trying to expand a section and be taken to the function's man page. Maybe use <summary><tt>multinom_reg()</tt> with the `"glmnet"` engine</summary>instead of <summary>`multinom_reg()` with the `"glmnet"` engine</summary>(or some way to avoid |
`multinom_reg()`: nnet, keras `mlp()`: nnet, keras `mars()`: earth
`logistic_reg()`: glm, glmnet, keras, LiblineaR, stan `linear_reg()`: lm, glmnet, keras, stan `decision_tree()`: rpart, C5.0 `boost_tree()`: xgboost, C5.0
|
There are now examples for all model/engine combinations with the exception of survival models and |
juliasilge
approved these changes
Jul 15, 2021
topepo
approved these changes
Jul 16, 2021
Co-authored-by: Julia Silge <julia.silge@gmail.com>
Co-authored-by: Julia Silge <julia.silge@gmail.com>
|
This pull request has been automatically locked. If you believe you have found a related problem, please file a new issue (with a reprex: https://reprex.tidyverse.org) and link to this issue. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #519
This PR adds an article with minimal examples for fitting and predicting.
Note that this currently sets
so that the site gets build and deployed to https://parsnip.tidymodels.org - this means that the site that will be online does include any changes which are part of the devel version of the pkg rather than just the CRAN version. The header of the site should indicate that it's the devel version via the version number.
We'll change the mode back to
after this PR but the site will stay like this until the next CRAN release.
To add more examples, add a
section to the
vignettes/articles/Example.Rmd. The indentation is necessary for the section to be properly collapsed in the pkgdown site. For the id, the convention is model-spec-engine where any capitalization in the engine name is kept, e.g.,id="svm-linear-LiblineaR". The id is used on the<model_engine>.Rmdhelp pages to link to the relevant section in the article.