Cheat Sheets and Vignettes

Package development
,
1

I just took a look at the cheat sheet templates, and I think it would be really good for me to add these to my packages.

I'm just confused about where to put the cheat sheets I write. I was thinking they should go in the vignettes folder.

Then what YAML header do I need to compile the cheat sheet. For an ordinary vignette, I would use:

output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Building Matrixes from Networks}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

Is there anything else I need to do, or will that just update the cheat sheet when it updates the package.

2

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

If you have a query related to it or one of the replies, start a new topic and refer back with a link.