README.md

In leekgroup/derfinderData: Processed BigWigs from BrainSpan for examples

derfinderData

Data package for derfinder and derfinderPlot examples.

Documentation

For more information about derfinderData check the vignettes through Bioconductor or at the documentation website.

Installation instructions

Get the latest stable R release from CRAN. Then install derfinderData from Bioconductor using the following code:

if (!requireNamespace("BiocManager", quietly = TRUE)) {
    install.packages("BiocManager")
}

BiocManager::install("derfinderData")

Citation

Below is the citation output from using citation('derfinderData') in R. Please run this yourself to check for any updates on how to cite derfinderData.

print(citation("derfinderData"), bibtex = TRUE)
#> To cite package 'derfinderData' in publications use:
#> 
#>   Collado-Torres L, Jaffe A, Leek J (2021). _derfinderData: Processed
#>   BigWigs from BrainSpan for examples_. R package version 2.19.0,
#>   <https://github.com/leekgroup/derfinderData>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     title = {derfinderData: Processed BigWigs from BrainSpan for examples},
#>     author = {Leonardo Collado-Torres and Andrew Jaffe and Jeffrey Leek},
#>     year = {2021},
#>     note = {R package version 2.19.0},
#>     url = {https://github.com/leekgroup/derfinderData},
#>   }

Please note that the derfinderData 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 derfinderData project is released with a Contributor 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 through usethis, remotes, sysreqs and rcmdcheck customized to use Bioconductor’s docker containers and BiocCheck.
• Code coverage assessment is possible thanks to codecov and covr.
• The documentation website is automatically updated thanks to pkgdown.
• The code is styled automatically thanks to styler.
• The documentation is formatted thanks to devtools and roxygen2.

For more details, check the dev directory.

This package was developed using biocthis.

leekgroup/derfinderData documentation built on May 4, 2024, 5:40 p.m.