create_docu_skeleton: Create a skeleton for a new Rmarkdown (Rmd) document

In charlotte-ngs/rmddochelper:

Description

create_docu_skeleton creates a skeleton document from a template. The template is either specified by a filepath to the template file or by a template name and a package which contains the template. The latter case 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 a function that is similar to rmarkdown::draft.

Usage

create_docu_skeleton(psDocuName, psPkgPath = ".", psRmdTemplate,
  psTemplatePkg = NULL, psDocuSubdir = "vignettes",
  pDocuHasOwnSubdir = TRUE, pbOverwrite = FALSE, pbEdit = TRUE,
  plReplace = NULL)

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
pbOverwrite	flag whether existing files are overwritten
pbEdit	directly open newly created document
plReplace	list with replacement key-values
pbDocuHasOwnSubdir	should document be stored in separate subdir

Details

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

charlotte-ngs/rmddochelper documentation built on June 27, 2019, 1:22 a.m.