Create a .Rmd template — makeRmdTemplate • startProject

`makRmdTemplate` will generate a .Rmd file with a header containing any project information provided in the function call.

Usage

makeRmdTemplate(
  rmd.dir = getwd(),
  rmd.name = NULL,
  rmd.output = "word",
  proj.title = NULL,
  proj.id = NULL,
  start.date = format(Sys.Date(), "%B %d, %Y"),
  version = "1",
  client = NULL,
  client.dept = NULL,
  main.statistician = NULL,
  stats.collab = NULL,
  rmd.purpose = NULL,
  rmd.notes = NULL
)

Arguments

rmd.dir: A character string specifying the file path where the template will be stored. Defaults to getwd().
rmd.name: NULL or a character string specifying the name of the .Rmd file. If NULL, the file will be named [proj.id]_rmd[currentdate]_v[version] or rmd[currentdate].
rmd.output: A character string specifying the type of Rmarkdown output to be created. Choices are: word, html or pdf. Defaults to word. #' @param proj.title NULL or a character string providing the full, descriptive project title to be used in template headers and memo subject lines.
proj.id: NULL or a short, clean character string providing a project identifier to be used as the directory name and as a prefix for template filenames. If NULL, a clean identifier will be automatically derived from [proj.title].
start.date: NULL or a character string providing the date to be included in the template header. Defaults to today's date.
version: NULL or a character string providing the project version to be included in the template name and/or header. Defaults to "1".
client: NULL or a character string providing the name(s) of client(s) to be included in the template header.
client.dept: NULL or a character string providing the affiliation of the client(s) to be included in the template header.
main.statistician: NULL or a character string providing the name of the primary statistician. This will be used in the template header.
stats.collab: NULL or a character string providing additional collaborators to be included as authors in the template header.
rmd.purpose: NULL or a character string providing the purpose for the generated template to be included in the template header.
rmd.notes: NULL or a character string providing additional notes to be included in the template header.

Details

You can append code and comments under the generated header by either creating a .basefile.Rmd file in your /home/<USERNAME> directory or by modifying the templates/basefile.Rmd file contained in the package library.

To find the location of your HOME directory, run `Sys.getenv("HOME")`.

To find the location of the included template file, run `system.file("templates", package = "startProject")`.

Author

Rocio Lopez, Rocio.LopezMoscoso@cuanschutz.edu

Examples

if (FALSE) makeRmdTemplate(rmd.name = "rmdTemplate") # \dontrun{}