How do I link to %>% with roxygen2 markdown

roxygen2
markdown

#1

The "Links" section of the {roxygen2} markdown vignette states:

Markdown notation can be used to create links to other manual pages. There are six kinds of links:
[...]
3. Link to a function from another package: [pkg::func()].

How would I do this with "special" functions like magrittr::%>% or base::%in%?

I have tried [base::%in%] and [base::`%in%`] among others, but to no avail.


#2

At the bottom of the documentation page you link to it says,

Links to operators

Links to operators or objects that contain special characters, do not work currently. E.g. to link to the %>% operator in the magrittr package, instead of [magrittr::%>%] , you will need to use the Rd notation: \code{\link[magrittr]{\%>\%}} .


#3

:flushed: OMG RTFM!
Thanks, Kieran. :smiley:


#4

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.