<—⬇️⬇️⬇️(Start of section that can be deleted after forking the template)⬇️⬇️⬇️—>
If you use the templateR
R package template, or any of the rworkflows
suite tools, please cite:
Brian M. Schilder, Alan E. Murphy, & Nathan G. Skene (2023) The rworkflows suite: automated continuous integration for quality checking, documentation website creation, and containerised deployment of R packages, Research Square; https://doi.org/10.21203/rs.3.rs-2399015/v1
templateR
is a template designed to make developing new R packages easy by providing:
rworkflows
).citation("<packageName>")
. Also used to auto-populate the README.Rmd.To get started, simply click on the green Use this template button at the top right of the templateR
repo.
To use certain features of rworkflows
, you may need to set up one or more GitHub Secrets:
PAT_GITHUB
[Optional]: Can grant access to private repos on GitHub Actions. You can generate your very own Personal Authentication Token with usethis::create_github_token()
. See the GitHub docs for details.DOCKER_TOKEN
[Optional]: Allows GitHub Actions to push to a DockerHub account.The GitHub Actions workflows included in this template will automatically create a documentation website for your package via GitHub Pages.
After the rworkflows
action has successfully run on Ubuntu for the first time, a new branch will appear in your repo called “gh-pages”.
<—⬆️⬆️⬆️(End of section that can be deleted after forking the template)⬆️⬆️⬆️—>
templateR
: packageTitle
If you use templateR
, please cite:
author1, author2, author3 (publicationYear) articleTitle, journalName; volumeNumber, linkToPublication
if(!require("remotes")) install.packages("remotes")
remotes::install_github("neurogenomics/templateR")
library(templateR)
utils::sessionInfo()
## R Under development (unstable) (2023-11-22 r85609)
## Platform: x86_64-pc-linux-gnu
## Running under: Ubuntu 22.04.3 LTS
##
## Matrix products: default
## BLAS: /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3
## LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.20.so; LAPACK version 3.10.0
##
## locale:
## [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C
## [3] LC_TIME=en_US.UTF-8 LC_COLLATE=en_US.UTF-8
## [5] LC_MONETARY=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8
## [7] LC_PAPER=en_US.UTF-8 LC_NAME=C
## [9] LC_ADDRESS=C LC_TELEPHONE=C
## [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
##
## time zone: UTC
## tzcode source: system (glibc)
##
## attached base packages:
## [1] stats graphics grDevices utils datasets methods base
##
## other attached packages:
## [1] rmarkdown_2.25
##
## loaded via a namespace (and not attached):
## [1] gtable_0.3.4 jsonlite_1.8.8 renv_1.0.3
## [4] compiler_4.4.0 BiocManager_1.30.22 rvcheck_0.2.1
## [7] scales_1.3.0 yaml_2.3.7 fastmap_1.1.1
## [10] here_1.0.1 ggplot2_3.4.4 R6_2.5.1
## [13] knitr_1.45 yulab.utils_0.1.0 tibble_3.2.1
## [16] desc_1.4.2 dlstats_0.1.7 munsell_0.5.0
## [19] rprojroot_2.0.4 pillar_1.9.0 RColorBrewer_1.1-3
## [22] rlang_1.1.2 utf8_1.2.4 cachem_1.0.8
## [25] badger_0.2.3 xfun_0.41 fs_1.6.3
## [28] memoise_2.0.1 cli_3.6.1 magrittr_2.0.3
## [31] rworkflows_1.0.0 digest_0.6.33 grid_4.4.0
## [34] lifecycle_1.0.4 vctrs_0.6.5 evaluate_0.23
## [37] glue_1.6.2 data.table_1.14.10 fansi_1.0.6
## [40] colorspace_2.1-0 tools_4.4.0 pkgconfig_2.0.3
## [43] htmltools_0.5.7