pkg <- read.dcf("DESCRIPTION", fields = "Package")[1] title <- gsub("\n"," ",read.dcf("DESCRIPTION", fields = "Title")[1]) description <- gsub("\n"," ",read.dcf("DESCRIPTION", fields = "Description")[1]) URL <- read.dcf('DESCRIPTION', fields = 'URL')[1] owner <- strsplit(URL,"/")[[1]][4] repo <- strsplit(URL,"/")[[1]][5]
\<---⬇️⬇️⬇️(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)⬆️⬆️⬆️--->
r pkg
: r gsub("\n","",title)
r gsub("\n","",description)
If you use r pkg
, please cite:
r utils::citation(pkg)$textVersion
if(!require("remotes")) install.packages("remotes") remotes::install_github("`r paste(owner,repo,sep='/')`") library(`r pkg`)
utils::sessionInfo()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.