ByrumLab / proteoDA

GNU General Public License v3.0
12 stars 11 forks source link

add install note for vignettes #226

Closed tjthurman closed 1 year ago

tjthurman commented 1 year ago

Might want to add a note in the README about installation and vignette building? I know Jordan (and maybe others) ran into issues when trying to install and build the vignettes (which requires some extra dependencies) versus a simple install without the vignettes.

Once we're on CRAN, they should build vignettes for us when creating binary packages. For people installing via GitHub, could mention that they may need some additional dependencies (knitr, Cairo, maybe png?) to build vignettes, and that if you run into issues installing with the vignettes, you can always install without them and check out the vignette on GitHub.