In LieberInstitute/jaffelab: Commonly used functions by the Jaffe lab

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

jaffelab

jaffelab is a package initially developed by Andrew E Jaffe's team at the Lieber Institute for Brain Development. It contains several helper functions used in their analyses.

Installation instructions

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

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

BiocManager::install("LieberInstitute/jaffelab")

Citation

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

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

Please note that the jaffelab 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 jaffelab 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'), 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.

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

LieberInstitute/jaffelab documentation built on April 1, 2024, 7:26 a.m.