use_rmarkdown_template: Add an RMarkdown Template

Description Usage Arguments Examples

View source: R/rmarkdown.R

Description

Adds files and directories necessary to add a custom rmarkdown template to RStudio. It creates:

Usage

1
2
3
4
5
6
use_rmarkdown_template(
  template_name = "Template Name",
  template_dir = NULL,
  template_description = "A description of the template",
  template_create_dir = FALSE
)

Arguments

template_name

The name as printed in the template menu.

template_dir

Name of the directory the template will live in within inst/rmarkdown/templates. If none is provided by the user, it will be created from template_name.

template_description

Sets the value of description in template.yml.

template_create_dir

Sets the value of create_dir in template.yml.

Examples

1
2
3
4
## Not run: 
use_rmarkdown_template()

## End(Not run)

usethis documentation built on Oct. 25, 2021, 9:06 a.m.