-
Notifications
You must be signed in to change notification settings - Fork 92
Revised model documentation #456
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea! Mainly we'd just need some good documentation about how this works (would also be nice to mention that _
gets subbed for -
when going from model name -> file name)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to get to an engine help page directly using its name? You might want to do that when you have already decided on the engine and don't want to click through from ?linear_reg
. I tried ?details-linear-reg-glmnet
but it didn't like the -
. Could we use _
or does that break something?
Feedback from the tidymodels and tidyverse group meetings:
|
Co-authored-by: Hannah Frick <hfrick@users.noreply.github.com>
Co-authored-by: Hannah Frick <hfrick@users.noreply.github.com>
Co-authored-by: Davis Vaughan <davis@rstudio.com>
What a set of changes 😅 but this is looking really great! 🙌 Other than the questions I have open above, I think the only other thing I want to check on in that we don't have these changes implemented for the survival models. That is as designed, correct? |
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. |
This restructures the model documentation files so that
parsnip
-adjacent packages are automatically discovered and linked if they use the same conventions.Each engine-specific man file links to a Rmd file in
man/rmd
. The naming convention of the man pages is critical for finding them automatically.Draft PR: only changes for
linear_reg()
and you'll need to runpak::pak("tidymodels/multilevelmod@doc-test")
to see how other engines from other packages show up.