README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
    collapse = TRUE,
    comment = "#>",
    fig.path = "man/figures/README-",
    out.width = "100%"
)
```

# chevreuldata

<!-- badges: start -->
[![GitHub issues](https://img.shields.io/github/issues/whtns/chevreuldata)](https://github.com/whtns/chevreuldata/issues)
[![GitHub pulls](https://img.shields.io/github/issues-pr/whtns/chevreuldata)](https://github.com/whtns/chevreuldata/pulls)
<!-- badges: end -->

The goal of `chevreuldata` is to store data for the chevreul package

## Installation instructions

Get the latest stable `R` release from [CRAN](http://cran.r-project.org/). Then install `chevreuldata` from [Bioconductor](http://bioconductor.org/) using the following code:

```{r 'install', eval = FALSE}
if (!requireNamespace("BiocManager", quietly = TRUE)) {
    install.packages("BiocManager")
}

BiocManager::install("chevreuldata")
```

And the development version from [GitHub](https://github.com/whtns/chevreuldata) with:

```{r 'install_dev', eval = FALSE}
BiocManager::install("whtns/chevreuldata")
```
## Example

This is a basic example which shows you how to solve a common problem:

```{r example, eval = requireNamespace('chevreuldata')}
library("chevreuldata")
## basic example code
```

Please note that the `chevreuldata` was only made possible thanks to many other R and bioinformatics software authors, which are cited either in the vignettes and/or the paper(s) describing this package.

## Code of Conduct

Please note that the `chevreuldata` project is released with a [Contributor Code of Conduct](http://bioconductor.org/about/code-of-conduct/). By contributing to this project, you agree to abide by its terms.

## Development tools

* Continuous code testing is possible thanks to [GitHub actions](https://www.tidyverse.org/blog/2020/04/usethis-1-6-0/)  through `r BiocStyle::CRANpkg('usethis')`, `r BiocStyle::CRANpkg('remotes')`, and `r BiocStyle::CRANpkg('rcmdcheck')` customized to use [Bioconductor's docker containers](https://www.bioconductor.org/help/docker/) and `r BiocStyle::Biocpkg('BiocCheck')`.
* Code coverage assessment is possible thanks to [codecov](https://codecov.io/gh) and `r BiocStyle::CRANpkg('covr')`.
* The [documentation website](http://whtns.github.io/chevreuldata) is automatically updated thanks to `r BiocStyle::CRANpkg('pkgdown')`.
* The code is styled automatically thanks to `r BiocStyle::CRANpkg('styler')`.
* The documentation is formatted thanks to `r BiocStyle::CRANpkg('devtools')` and `r BiocStyle::CRANpkg('roxygen2')`.

For more details, check the `dev` directory.

This package was developed using `r BiocStyle::Biocpkg('biocthis')`.