# topdownr
<!-- badges: start -->
[](https://www.repostatus.org/#active)
[](https://github.com/sgibb/topdownr/actions)
[](https://codecov.io/github/sgibb/topdownr/?branch=master)
[](https://www.gnu.org/licenses/gpl-3.0.html)
[](https://bioconductor.org/packages/release/bioc/html/topdownr.html)
[](https://bioconductor.org/packages/stats/bioc/topdownr/)
Release: [](https://bioconductor.org/checkResults/release/bioc-LATEST/topdownr/)
Devel: [](https://bioconductor.org/checkResults/devel/bioc-LATEST/topdownr/)
<!-- badges: end -->
## Installation
```r
if (!require("BiocManager"))
install.packages("BiocManager")
BiocManager::install("topdownr")
```
If you want to install the development version from github
(not recommended unless you know what you are doing):
```r
if (!require("BiocManager"))
install.packages("BiocManager")
BiocManager::install("sgibb/topdownr")
```
## Documentation
To get started:
```r
?"topdownr-package"
vignette("data-generation", package="topdownr")
vignette("analysis", package="topdownr")
```
Development documentation: https://sgibb.github.io/topdownr/
## Questions
General questions should be asked on
the [Bioconductor support forum](https://support.bioconductor.org/),
using `topdownr` to tag the question. Feel also free to open a
GitHub [issue](https://github.com/sgibb/topdownr/issues), in
particular for bug reports.
## Contribution
See [CONTRIBUTING.md](CONTRIBUTING.md).
## Support
See [SUPPORT.md](SUPPORT.md).
