R: Use a usethis-style template

use_template {usethis}

R Documentation

Use a usethis-style template

Description

Creates a file from data and a template found in a package. Provides control over file name, the addition to .Rbuildignore, and opening the file for inspection.

Usage

use_template(template, save_as = template, data = list(),
  ignore = FALSE, open = FALSE, package = "usethis")

Arguments

`template`	Path to template file relative to `templates/` directory within `package`; see details.
`save_as`	Name of file to create. Defaults to `template`
`data`	A list of data passed to the template.
`ignore`	Should the newly created file be added to `.Rbuildignore`?
`open`	Open the newly created file for editing? Happens in RStudio, if applicable, or via `utils::file.edit()` otherwise.
`package`	Name of the package where the template is found.

Details

This function can be used as the engine for a templating function in other packages. The template argument is used along with the package argument to determine the path to your template file; it will be expected at system.file("templates", template, package = package).

To interpolate your data into the template, supply a list using the data argument. Internally, this function uses whisker::whisker.render() to combine your template file with your data.

Value

A logical vector indicating if file was modified.

Examples

## Not run: 
  # Note: running this will write `NEWS.md` to your working directory
  use_template(
    template = "NEWS.md",
    data = list(Package = "acme", Version = "1.2.3"),
    package = "usethis"
  )

## End(Not run)

[Package usethis version 1.4.0 Index]