How to write the installation section in the vignette of a package that has not been sent into Bioconductor yet
1
0
Entering edit mode
Krutik Patel ▴ 10
@kpatel5-22049
Last seen 7 months ago
Newcastle University, UK

Hello Bioconductor,

I am developing my first package as a part of my PhD and I am having some difficulties with understanding the procedures involved in correctly maintaining my package to the standard which the bioconductor new package guidelines state.

One of my areas of confusion is the requirement to show how to install my package from bioconductor on a vignette. The following line is found in the Package guidelines https://www.bioconductor.org/developers/package-guidelines/#vignettes.

"2. Add an “Installation” section that show to users how to download and load the package from Bioconductor."

I have not yet uploaded my package onto bioconductor (atm it is on a private github) so how could I add an installation for my package from bioconductor?

Do I just ignore the fact that my package is not on bioconductor yet, and proceed as shown below?

if (!requireNamespace("BiocManager", quietly = TRUE))
install.packages("BiocManager")

BiocManager::install("Packagename")


Any help or guidance would be most appreciated, Krutik.

newpackage vignette installation • 523 views
2
Entering edit mode
shepherl 3.3k
@lshep
Last seen 15 hours ago
United States

Yes you should ignore the fact that it is not on Bioconductor yet and include the above section. Keep in mind code like this, that shows installation, should be in a code chunk set with eval=FALSE so that it is not actually run (even when it is on officially on Bioconductor). If you are afraid you will have user find it you could add a temporary line that says pending acceptance .

0
Entering edit mode

This makes sense, thank you.