[](https://www.repostatus.org/#active)
[](https://github.com/RforMassSpectrometry/CompoundDb/actions?query=workflow%3AR-CMD-check-bioc)
[](https://codecov.io/github/RforMassSpectrometry/CompoundDb?branch=master)
[](https://opensource.org/licenses/Artistic-2.0)
[](https://bioconductor.org/packages/release/bioc/html/CompoundDb.html)
[](https://bioconductor.org/packages/stats/bioc/CompoundDb/)
[](https://bioconductor.org/checkResults/release/bioc-LATEST/CompoundDb/)
[](https://bioconductor.org/checkResults/devel/bioc-LATEST/CompoundDb/)
`CompoundDb` ... preserve compound annotations.
# Installation and requirements
The package can be installed with
```r
install.packages(c("BiocManager", "remotes"))
BiocManager::install("RforMassSpectrometry/CompoundDb")
```
# Creating and using (chemical) compound databases
This package provides functionality to create and use compound databases
generated from (mostly publicly) available resources such as
[HMDB](http://www.hmdb.ca), [ChEBI](https://www.ebi.ac.uk/chebi/) and
[PubChem](https://pubchem.ncbi.nlm.nih.gov).
# How to contribute
Contributions are welcome, but should follow certain guidelines:
1) Open an issue.
2) Create a new branch (internal collaborator) or fork the repository (external
contributor).
3) Add your code (following loosly Bioconductor's [coding
style](http://bioconductor.org/developers/how-to/coding-style/).
4) Ensure the package passes `R CMD build` and `R CMD check`.
5) Make a pull request.
