I am writing a function that passes one of its arguments to tidyselect::eval_select(), and I would like to indicate in the documentation (generated with roxygen2) that this argument uses tidy selection.
Function arguments in, e.g., tidyr or dplyr that use tidy selection have a tag that links to a documentation topic on using tidy selection with that package; for example, tidyr uses:
<[`tidy-select`][tidyr_tidy_select]>
However, I would prefer to link to an existing documentation topic for tidy selection rather than include one specific to my package. The tidyselect repository includes a very helpful documentation topic on tidy-selection arguments, but it is marked as internal so this does not work:
<[`tidy-select`][tidyselect::args_tidy_select]>
Is there a preferred method for marking arguments that use tidy selection? The options I see are:
- Emulate tidyr/dplyr by including a documentation topic on tidy selection specific to my package
- Ship with a copy of the
args_tidy_selecttopic from tidyselect - Link to the tidyselect syntax vignette (using HTTP)