Description Usage Arguments Details
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".
1 2 3 4 | create_docu_skeleton(psDocuName, psPkgPath = ".",
psRmdTemplate = "project_docu", psTemplatePkg = "rqudocuhelper",
psDocuSubdir = "vignettes", pbDocuHasOwnSubdir = TRUE,
pbOverwrite = FALSE, pbEdit = FALSE)
|
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 |
The basic functionality follows the function
devtools::use_vignette
, except for the possibility
of specifying any given template from any package.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.