create_odg_graphic: Create an empty odg graphic

Description Usage Arguments Details

Description

create_odg_graphic uses templates which are either provided by the caller or which are stored in the rmarkdown/template directory of this package 'rmddochelper'. When calling create_odg_graphic without any arguments, then the template is opened using soffice draw. When a filename for the odg graphic which should be created, is specified the template is renamed to the given name.

Usage

1
2
3
4
5
create_odg_graphic(psGraphicName = "skeleton.odg",
  psGraphicPath = "vignettes", psRmdSrcFile = NULL, psGrFmt = "pdf",
  psOdgTemplate = "odg_figure", psTemplatePkg = "rmddochelper",
  create_dir = "default", pbRecursive = TRUE, pbEdit = TRUE,
  psChunkLabel = "echo=FALSE, odg.conv=TRUE, odg.path=\"odg\", odg.graph.cache=TRUE")

Arguments

psGraphicName

Format of diagram to be created

psGraphicPath

Path where created odg file should be stored

psRmdSrcFile

rmd source file where include statement is inserted

psGrFmt

graphics format

psOdgTemplate

name of the template to be used

psTemplatePkg

package where template is stored

create_dir

should created odg file be stored in separate directory

pbRecursive

recursively create complete path to graphic file

pbEdit

directly edit created odg file

psChunkLabel

string with additional chunk labels

Details

If the parameter psRmdSrcFile is specified, a command to include the created graphic file in the specified format is inserted into the rmd-source file. If psRmdSrcFile is left at its default (null) then no include command is inserted. The command to include graphics is based on the function knitr::include_graphics(). When specifying the parameter psChunkLabel an additional chunk label can be specified.


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