Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.97 KB

README.md

File metadata and controls

37 lines (23 loc) · 1.97 KB

biocompute

Lifecycle: experimental CRAN Version Travis build status Downloads from the RStudio CRAN mirror

Seven Bridges implementation of the BioCompute Object (BCO) specification. Offers the capabilities to compose, validate, and convert BioCompute Objects with R.

Users can encode information in data frames, and compose BioCompute Objects (BCO) from the domains defined by the standard. A checksum validator and a JSON schema validator are provided. This package also supports exporting BioCompute Objects as JSON, PDF, HTML, or Word documents, and exporting to cloud-based platforms.

Check out the introduction vignette or the case study vignette to get started.

To see the library used in a real use case, refer to the BCO App repository.

Installation

To download and install biocompute from CRAN:

install.packages("biocompute")

Or try the development version on GitHub:

# install.packages("remotes")
remotes::install_github("sbg/biocompute")

Note: the code in this repository is the most up to date, and this version is not available for install in CRAN. If you are looking for a version of the library that is more consistent with the BCO standard, it is recommended you install the development version from this repository.

Copyright

© 2021 Seven Bridges Genomics, Inc. All rights reserved.

This project is licensed under the GNU Affero General Public License v3.