The BiocCheck package provides a set of tools for checking a package
against the current version of Bioconductor coding and style standards.
To install this package, start R and enter:
if (!requireNamespace("BiocManager", quietly = TRUE))
install.packages("BiocManager")
BiocManager::install("BiocCheck")The Bioconductor guidelines are available at
https://contributions.bioconductor.org/. This site provides the basis for
many of the checks performed by BiocCheck. We encourage packages to
follow these guidelines to ensure that they are of high quality and
interoperate well with other Bioconductor packages.
To check a package, use the BiocCheck::BiocCheck() function. For
example, to check the BiocCheck package itself, use:
BiocCheck::BiocCheck("BiocCheck")in the directory above the source package directory.
Note that the BiocCheck package must be installed to use this function.
If you are using RStudio, you can use the BiocCheck addin to check a
package. First, install the BiocAddins package:
BiocManager::install("Bioconductor/BiocAddins")Then, in RStudio, click on the "Addins" menu, and select "Run BiocCheck".
The BiocCheck package contains a vignette that describes the package
in more detail. To view the vignette, start R and enter:
vignette("BiocCheck")