https://github.com/jimbrig/templateeR

Collection of templates for R
https://github.com/jimbrig/templateeR

rstats templates

Last synced: 3 months ago
JSON representation

Collection of templates for R

• Host: GitHub
• URL: https://github.com/jimbrig/templateeR
• Owner: jimbrig
• License: other
• Created: 2022-01-22T23:04:04.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-17T01:02:53.000Z (about 2 years ago)
• Last Synced: 2024-06-05T00:43:54.384Z (5 months ago)
• Topics: rstats, templates
• Language: R
• Homepage:
• Size: 130 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - jimbrig/templateeR - Collection of templates for R (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# templateeR

[![R-CMD-check](https://github.com/jimbrig/templateeR/workflows/R-CMD-check/badge.svg)](https://github.com/jimbrig/templateeR/actions)

`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](CHANGELOG.md)*

## Installation

You can install the development version of `templateeR` from

[GitHub](https://github.com/) with: [^1]

``` r

pak::pak("jimbrig/templateeR")

```

## Templates

### General

-   [use_git_cliff](R/use_git_cliff.R) - 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](R/render_template.R) - function that renders

    template files similar to `usethis::use_template`, but more

    flexible. Utilizes `whisker::whisker.render` and `{{}}` / `{{{}}}`

    syntax.

-   [msg_helpers](R/msg_helpers.R) - 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](R/use_gh_labels.R) - Apply customized GitHub Issue

    labels to your repository with the option to utilize a `labels.yml`

    configuration file. See the [labels.yml](https://github.com/jimbrig/templateeR/blob/main/.github/labels.yml)

    configuration file for this repository for details.

-   [github_actions](R/github_actions.R) - Suite of github workflows to

    add to your repository. Currently supported functions are:

    -   `use_git_cliff_action`

### R Development

-   [use_pkgdevt_script](R/use_pkgdevt_script.R) - Adds a `pkgdevt.R`

    template script to your current working directory (assuming working

    on a package). See [this package's `pkgdevt.R`

    script](inst/scripts/pkgdevt.R) 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()`