https://github.com/bioconductor/bioccheck

https://github.com/bioconductor/bioccheck

bioconductor-package core-services

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/bioconductor/bioccheck
• Owner: Bioconductor
• Created: 2015-06-05T19:07:09.000Z (almost 11 years ago)
• Default Branch: devel
• Last Pushed: 2025-03-28T17:27:37.000Z (about 1 year ago)
• Last Synced: 2025-03-29T06:07:28.951Z (about 1 year ago)
• Topics: bioconductor-package, core-services
• Language: R
• Homepage: http://bioconductor.org/packages/BiocCheck
• Size: 4.96 MB
• Stars: 8
• Watchers: 13
• Forks: 27
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS

Awesome Lists containing this project

README

          
# [BiocCheck](https://bioconductor.org/packages/BiocCheck)

---

[![BioC status](http://www.bioconductor.org/shields/build/devel/bioc/BiocCheck.svg)](https://bioconductor.org/checkResults/devel/bioc-LATEST/BiocCheck)

[![Platforms](http://www.bioconductor.org/shields/availability/devel/BiocCheck.svg)](https://www.bioconductor.org/packages/devel/bioc/html/BiocCheck.html#archives)

[![Codecov test coverage](https://codecov.io/gh/Bioconductor/BiocCheck/graph/badge.svg)](https://app.codecov.io/gh/Bioconductor/BiocCheck)

[![Downloads](http://www.bioconductor.org/shields/downloads/devel/BiocCheck.svg)](https://bioconductor.org/packages/stats/bioc/BiocCheck)

The `BiocCheck` package provides a set of tools for checking a package

against the current version of Bioconductor coding and style standards.

## Installation 

To install this package, start R and enter:

```r

if (!requireNamespace("BiocManager", quietly = TRUE))

    install.packages("BiocManager")

BiocManager::install("BiocCheck")

```

## Bioconductor Guidelines

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.

## Usage

To check a package, use the `BiocCheck::BiocCheck()` function. For

example, to check the `BiocCheck` package itself, use:

```r

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:

```r

BiocManager::install("Bioconductor/BiocAddins")

```

Then, in RStudio, click on the "Addins" menu, and select "Run BiocCheck".

## Documentation

The `BiocCheck` package contains a vignette that describes the package

in more detail. To view the vignette, start R and enter:

```r

vignette("BiocCheck")

```