rroxygen2vignette

How to insert function input documentation in R vignette?

I want to write a vignette explaining my R package. Inside the vignette, I want to explain one input to a certain function.

Basically, what I would write in the vignette is the same as I wrote in the @param section of the roxygen comments to my function.

To avoid writing the same things twice, is there a way that I can insert the roxygen2 description of a function input into a vignette?

Solution

  • The printr package of Yihui Xie provides what I need, see https://cran.r-project.org/web/packages/printr/vignettes/printr.html#help-pages.