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

Think about adding roxygen topics for "special" functions #401

Open
DavisVaughan opened this issue Sep 18, 2023 · 2 comments
Open

Think about adding roxygen topics for "special" functions #401

DavisVaughan opened this issue Sep 18, 2023 · 2 comments

Comments

@DavisVaughan
Copy link

I got a question in the workshop about the fact that you can't do ?drift and pull up any information on the drift() special. I get that this isn't a "real" function, but I wonder if you could somehow add a topic page so that ?drift takes you to the ?NAIVE page so you can still see something like this https://fable.tidyverts.org/reference/RW.html#specials

If drift() can be used in multiple different model types, maybe it can be a landing page specific to drift that can let you then click through to whatever specific model you are interested in using drift with

@DavisVaughan
Copy link
Author

We did this with the join_by() DSL a little bit here with aliases:
https://github.com/tidyverse/dplyr/blob/73742713bc61d4ef079e72b806143b23cb7c4871/R/join-by.R#L137

So that you can do ?closest to get to the right place

@mitchelloharawild
Copy link
Member

Registering specials for clicking through different model types is a good approach that I hadn't considered for specials before. A difficulty of this is that the same special (by name) might apply to multiple models across multiple packages. I suppose the landing page could be specific to each package.

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

No branches or pull requests

2 participants