In derfinderHelper: derfinder helper package

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

derfinderHelper

Helper package for derfinder.

Documentation

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

Installation instructions

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

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

BiocManager::install("derfinderHelper")

Citation

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

print(citation("derfinderHelper"), bibtex = TRUE)

Please note that the derfinderHelper 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 derfinderHelper 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 r BiocStyle::CRANpkg('usethis'), r BiocStyle::CRANpkg('remotes'), r BiocStyle::Githubpkg('r-hub/sysreqs') and r BiocStyle::CRANpkg('rcmdcheck') customized to use Bioconductor's docker containers and r BiocStyle::Biocpkg('BiocCheck').
• Code coverage assessment is possible thanks to codecov and r BiocStyle::CRANpkg('covr').
• The documentation website 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.

derfinderHelper documentation built on Dec. 20, 2020, 2 a.m.