Search code examples
rknitrr-markdownroxygen2

Reference package vignettes with Roxygen2

So, I'd like to reference one of my package vignettes inside the roxygen2 comments of a function but I'm having a hard time understanding how to do it.

More generally, how do we reference documents inside /inst/doc? E.g. I'd like to reference /inst/doc/mypdf.pdf inside the roxygen2 comments for myFunc. What would that look like? Is it even possible?

Solution

  • I just tell people to run the code that opens the vignette:

    #' For more details see the help vignette:
#' \code{vignette("help", package = "mypkg")}