rksfun

These are some commonly used functions in my work. I have created this package to make my work easier. I hope you find it useful too.

Installation instructions

Get the latest stable R release from CRAN. Then install the development version from GitHub with:

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

Citation

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

print(citation("rksfun"), bibtex = TRUE)
#> Warning in citation("rksfun"): could not determine year for 'rksfun' from
#> package DESCRIPTION file
#> To cite package 'rksfun' in publications use:
#> 
#>   Stöckl R (????). _rksfun: rksfun - a collection of usefull (to me)
#>   code_. R package version 0.0.0.9000,
#>   https://richardstoeckl.github.io/rksfun/,
#>   <https://github.com/richardstoeckl/rksfun>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     title = {rksfun: rksfun - a collection of usefull (to me) code},
#>     author = {Richard Stöckl},
#>     note = {R package version 0.0.0.9000, https://richardstoeckl.github.io/rksfun/},
#>     url = {https://github.com/richardstoeckl/rksfun},
#>   }

Please note that the rksfun 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.

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.