crss_changes_template: Create a template for documenting changes to CRSS

Description Usage Arguments Value Examples

View source: R/crss_changes_template.R

Description

crss_changes_template() creates a template for documenting the changes to CRSS since the last release. The template is in RMarkdown and can then be knit to pdf, and provided with the CRSS package.

Usage

1
crss_changes_template(filename = NULL, path = NULL)

Arguments

filename

The name of the file to create. If NULL will be crss_changes_template.Rmd. If specified can have a .Rmd extension, and if it does not, it will be added.

path

Where to create the file. If NULL will be in the current directory.

Value

Invisibly returns the full file name if successful. Otherwise returns FALSE.

Examples

1
2
3
4
5
6
7
## Not run: 
# create January2020.Rmd in the current directory
crss_changes_template("January2020")
# create crss_changes_template.Rmd in C:/test
crss_changes_template(path = "C:/test")

## End(Not run)

BoulderCodeHub/crssrelease documentation built on March 5, 2021, 6:19 p.m.