create_docu_skeleton: Create a new Rmarkdown (Rmd) document

In pvrqualitasag/rqudocuhelper:

Description

create_docu_skeleton assumes that psPkgPath is a directory that contains an R-package. By default the new document is created in subdirectory "vignettes". If this subdirectory does not exist, it is created. The document is generated by the function rmarkdown::draft using the template "project_docu".

Usage

create_docu_skeleton(psDocuName, psPkgPath = ".",
  psRmdTemplate = "project_docu", psTemplatePkg = "rqudocuhelper",
  psDocuSubdir = "vignettes", pbDocuHasOwnSubdir = TRUE,
  pbOverwrite = FALSE, pbEdit = FALSE)

Arguments

psDocuName	name of the new document
psPkgPath	path where package is located under which document should be created
psRmdTemplate	name of the template to be used
psTemplatePkg	package from where the template should be taken
psDocuSubdir	subdirectory in which document should be saved to
pbDocuHasOwnSubdir	should document be stored in separate subdir
pbOverwrite	flag whether existing files are overwritten
pbEdit	directly open newly created document

Details

The basic functionality follows the function devtools::use_vignette, except for the possibility of specifying any given template from any package.

pvrqualitasag/rqudocuhelper documentation built on May 26, 2019, 11:34 a.m.