Skip to content
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

Add examples for using recipes and model formulas #1

Open
cimentadaj opened this issue Jun 10, 2020 · 3 comments
Open

Add examples for using recipes and model formulas #1

cimentadaj opened this issue Jun 10, 2020 · 3 comments

Comments

@cimentadaj
Copy link

Thanks a lot for this package, it's a great addition to tidymodels! I've been following the conversation on multilevel models and tidymodels somewhere else I can't remember and I think it would be very useful to provide some documentation (vignette, README) on how to combine recipes and model formulas.

This can become a bit complex if your recipe is very long and then having to define the model formula separately.

Just leaving it here in case it's useful.

@juliasilge
Copy link
Member

We do really need to add this kind of documentation, as folks look for guidance and can't find it. Perhaps as an "extra" non-CRAN vignette for the pkgdown site.

@topepo
Copy link
Member

topepo commented Nov 10, 2021

When you load multilevelmod, the parsnip man pages should update the list of engines:

image

(This is with recent versions of parsnip)

Those links give you more specific information about the models and how to use them. For the lmer engine, here is what that looks like (on the pkgdown site at least). There is some of that information but let us know if there are gaps.

We are working more on surfacing the documentation. It occurs to me, as I had to figure out where the information is on the pkgdown site, that we should add them to the reference section.

I think that a separate article would be great (with a worked example). This video (slides here) might also be helpful.

@juliasilge
Copy link
Member

The censored package has the same problem and @hfrick said she is going to add links to that table in the README for engine detail pages; maybe we should do all the parsnip extension packages the same way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants