compose: Compose a new Rmarkdown document based on a template

Description Usage Arguments Examples

Description

Compose a new Rmarkdown document based on a template

Usage

1
2
compose(file, template, package = NULL, create_dir = "default",
  edit = TRUE, ...)

Arguments

file

File name for the draft

template

Template to use as the basis for the draft. This is either the full path to a template directory or the name of a template directory within the rmarkdown/templates directory of a package.

package

(Optional) Name of package where the template is located.

create_dir

TRUE to create a new directory for the document (the "default" setting leaves this behavior up to the creator of the template).

edit

TRUE to edit the template immediately

...

additional metadata variables to include in the YAML front matter. NOTE: dots within variable names will be replaced with hyphens in the output (e.g., font.family will become font-family).

Examples

1
compose("report.Rmd", author = "Aaron Wolen")

aaronwolen/composer documentation built on May 28, 2019, 3:22 p.m.