create_rmd_document: Create a document from a template

Description Usage Arguments Details

Description

The function create_rmd_document copies a template document from any given package to the path that is specified using the name that is given with parameter psDocuName.

Usage

1
2
3
create_rmd_document(psDocuName, psDocuPath = ".",
  psRmdTemplate = "pdf_document", psTemplatePkg = "rcoursetools",
  pbCreateDocuSubdir = TRUE, pbEdit = TRUE)

Arguments

psDocuName

name of the new document without extension

psDocuPath

path where document should be created

psRmdTemplate

name of the template to be used

psTemplatePkg

package from where the template should be taken

pbCreateDocuSubdir

separate subdirectory for document psDocuName

pbEdit

directly open newly created document

Details

The format of the created document is assumed to be Rmarkdown. The extension .Rmd will be added to the given document name. This function does not make any assumption about the environment in which the new document is created. Hence this function can be used outside of R-Packages or RStudio-projects.


charlotte-ngs/rcoursetools documentation built on May 13, 2019, 3:34 p.m.