README.md

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)
#> 
#> To cite package 'jaffelab' in publications use:
#> 
#>   Leonardo Collado-Torres, Andrew E. Jaffe and Emily E. Burke (2021).
#>   jaffelab: Commonly used functions by the Jaffe lab. R package version
#>   0.99.31. https://github.com/LieberInstitute/jaffelab
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     title = {jaffelab: Commonly used functions by the Jaffe lab},
#>     author = {Leonardo Collado-Torres and Andrew E. Jaffe and Emily E. Burke},
#>     year = {2021},
#>     note = {R package version 0.99.31},
#>     url = {https://github.com/LieberInstitute/jaffelab},
#>   }

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 usethis, remotes, 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.