templateeR

templateeR is an R package providing a suite of various R related templates.

The goal of templateeR is to provide the R developer easy-to-use, reproducible templates. Additionally, templateer attempts to provide developer’s more general best practice templates for various workflows and projects.

Keep up-to-date with the latest changes by checking out this package’s Changelog

Installation

You can install the development version of templateeR from GitHub with: [^1]

# pak::pak("jimbrig/templateeR")
install.packages("templateeR", repos = c('https://jimbrig.r-universe.dev', 'https://cloud.r-project.org'))

Templates

General

• use_git_cliff - function that generates necessary files to implement git-cliff functionality for the repo. git-cliff auto-generates a CHANGELOG.md using the Keep a Changelog methodology with a provided cliff.toml configuration file.

• render_template - function that renders template files similar to usethis::use_template, but more flexible. Utilizes whisker::whisker.render and {{}} / {{{}}} syntax.

• msg_helpers - generic user feedback console helper functions ( i.e. msg_bullet, msg_done, msg_err, msg_path, etc.). Applied to this package via jimstools::use_feedback_helpers().

GitHub

• use_gh_labels - Apply customized GitHub Issue labels to your repository with the option to utilize a labels.yml configuration file. See the labels.yml configuration file for this repository for details.

• github_actions - Suite of github workflows to add to your repository. Currently supported functions are:

  • use_git_cliff_action

R Development

• use_pkgdevt_script - Adds a pkgdevt.R template script to your current working directory (assuming working on a package). See this package’s pkgdevt.R script for reference.

Roadmap

• ShinyApp Templates
• RStudio Project Templates
• RStudio Addins
• RMarkdown Templates
• Dockerfile Templates
• Deployment Script Templates
• Package Development Workflow Templates
• Additional GitHub Actions
• Database and SQL Templates
• Plumber API Templates

---

Jimmy Briggs | 2022

[^1]: Similarly, you can install the package using the more common devtools::install_github() and remotes::install_github()