search

Bioconductor / Biostrings

Efficient manipulation of biological strings
https://bioconductor.org/packages/Biostrings
54 stars 16 forks source link

BiostringsQuickOverview.Rnw to Rmd #72

Closed raoulkam closed 1 year ago

raoulkam commented 2 years ago

First drat for review @jwokaty

hpages commented 2 years ago

Hi @raoulkam,

R CMD build won't render that R markdown (.Rmd) document unless you make at least the 3 following adjustments:

  1. Add the following directives in the header section of the Rmd file (typically between the date: and output: entries):

    vignette: >
  %\VignetteIndexEntry{Biostrings Quick Overview}
  %\VignettePackage{Biostrings}
  %\VignetteEngine{knitr::rmarkdown}

  2. Add VignetteBuilder: knitr to the DESCRIPTION file.

  3. Add knitr to the Suggests: field (DESCRIPTION file).

On a side note I'm not sure I see the benefits of converting this quick reference card into an .Rmd vignette. Think of it as a "cheat sheet" kind of document. Generally speaking not all Sweave (.Rnw) documents in the vignettes/ folder of a package need to be converted to R markdown. "Cheat sheet" style documents are one of them.

Thanks, H.