https://github.com/ElianHugh/templater
use and create R templates in vscode-r
https://github.com/ElianHugh/templater
package r r-templates rmarkdown-templates templates vscode vscode-r
Last synced: 3 months ago
JSON representation
use and create R templates in vscode-r
- Host: GitHub
- URL: https://github.com/ElianHugh/templater
- Owner: ElianHugh
- License: gpl-3.0
- Archived: true
- Created: 2020-11-07T05:41:59.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-22T06:33:45.000Z (about 4 years ago)
- Last Synced: 2024-08-13T07:13:24.594Z (6 months ago)
- Topics: package, r, r-templates, rmarkdown-templates, templates, vscode, vscode-r
- Language: R
- Homepage:
- Size: 235 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - ElianHugh/templater - use and create R templates in vscode-r (R)
README
---
output: github_document
---
# templater
> Allows for the use of markdown templates from installed R-packages (e.g. [papaja](https://github.com/crsh/papaja)), and for the creation of user-generated templates.
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://travis-ci.com/ElianHugh/templater)
[](https://github.com/ElianHugh/templater/actions)
[](https://codecov.io/gh/ElianHugh/templater)
*{templater}* is an attempt to bring template usage to [VSCode-R](https://github.com/Ikuyadeu/vscode-R). templater scans your installed packages for templates that can be used to create rmarkdown files. templater also comes with some basic templates that can be used to quickly get started on a project, without having to deal with all the extra bells and whistles that come with complicated templates. templater also allows for the creation of basic user-templates.
Future updates will include other (i.e. non-markdown) templates.
# Installation
Install with:
```r
remotes::install_github("ElianHugh/templater")
```
# Opening Templater
*{templater}* can be called by first loading it into your r session and then running its shiny gadget
```r
library(templater)
templater()
```
Alternatively, you can call templater through the addin interface, meaning you don't have to make a library call. This will work in vscode-r as long as you have rstudioapi enabled.
# Template Usage
Markdown templates can be found under the "Markdown Templates" tab, which lists both package templates and templater templates (including user-generated templates). You can use the search function to find your desired template quickly.
Once you have selected a template, input a file name and choose where to save the file. Clicking done will close templater and open up the new rmarkdown file.
# Template Creation
You can also use templater to create templates for later use. Navigate to the "Create Templates" tab, and type in your new template's name, description, and body.
The body contains _both_ the YAML header and rmarkdown body. When writing the body, make sure you include the YAML header first. For example:
```rmd
---
title: "Untitled"
output: html_document
---
# Header
## Subheader
```
# IDE Differences
templater is unlikely to be useful for those using RStudio, but I hope that it might find some use amongst vscode users. For extra functionality (e.g. navigating to new files, IDE dialog, etc.) I am using the new rstudioapi emulation employed by VSCode-R, so there shouldn't be any difference in templater functionality between the two IDEs. Below you can see templater running in both vscode and RStudio.
#### VSCode-R
#### RStudio
