Skip to content

Updates for new aorsf engine for rand_forest() #828

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

Merged
merged 11 commits into from
Nov 4, 2022

Conversation

bcjaeger
Copy link
Contributor

@bcjaeger bcjaeger commented Oct 10, 2022

Closes #827

Hello!

I would like to include the oblique random survival forest in parsnip as an engine for censored regression. I have reviewed the guidelines for contributing engine level documentation and have made .Rmd and .R files for aorsf that mimic existing files for random forest engines, e.g., partykit.

Following the engine-specific guidelines in inst/README-DOCS.md,

  1. Use roxygen comments to generate the main .Rd file that R's help system uses.
  2. Create an .Rmd file that has the details of the engine.
  3. Knit the .Rmd file to .md so the .Rd file from step 1 can link it.
  4. Once you are done, run devtools::document() (or use the RStudio IDE) to build the help files.

I had a little trouble on step 3. Knitting my .Rmd file, the error package 'parsnip' required by 'censored' could not be found occurred. So I did not commit the .Rd file. I've tried to figure out what is causing parsnip to be undetected, but haven't figured it out yet.

If you make a PR with a new engine, you can work on the .Rmd file and the tidymodels folks can go through the process of merging it in (but let us know if you want us to do that in the PR).

Since aorsf is a new engine and I am having trouble creating the .Rd file, may I request help getting the documentation files to knit as intended?

@hfrick hfrick self-assigned this Nov 1, 2022
@hfrick
Copy link
Member

hfrick commented Nov 1, 2022

@topepo can you have a look at this, too? This PR now contains all the changes related to the new aorsf engine for censored regression with rand_forest():

The corresponding PR on censored is tidymodels/censored#211 if you want more context.

@hfrick hfrick requested a review from topepo November 1, 2022 19:37
@hfrick hfrick changed the title rand_forest_aorsf included in docs Updates for new aorsf engine for rand_forest() Nov 1, 2022
@hfrick
Copy link
Member

hfrick commented Nov 3, 2022

  • todo for myself: add a note about case weights to the docs

topepo and others added 3 commits November 3, 2022 10:19
this should be removed once the changes in aorsf are on CRAN
@hfrick
Copy link
Member

hfrick commented Nov 3, 2022

@topepo this is ready to merge 👍

fit_xy() now works with the dev version of aorsf thanks to @bcjaeger changes in aorsf but I'm leaving fit_xy.rand_forest() in parsnip until the dev version of aorsf makes it to CRAN.

@hfrick hfrick merged commit b208872 into tidymodels:main Nov 4, 2022
@bcjaeger bcjaeger deleted the aorsf branch November 4, 2022 12:41
@bcjaeger
Copy link
Contributor Author

bcjaeger commented Nov 4, 2022

Thank you! 😃

@github-actions
Copy link

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.

@github-actions github-actions bot locked and limited conversation to collaborators Nov 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add aorsf engine to rand_forest?
3 participants