use_odg_graphic: Create New ODG Graphics Object

In charlotte-ngs/rmddochelper:

Description

Similar to the devtools::use_* functions, we want to create a new ODG graphics object. This new graphics object will be stored in a file which is copied from a template from a given R-package. By default, the template used is called odg_figure from the rmddochelper package. After copying the template, it can be modified using a pre-defined tool. By default this tool is LibreOffice draw.

Usage

use_odg_graphic(ps_path, ps_cwd = getwd(), ps_rmd_src = NULL,
  ps_odg_template = "odg_figure", ps_template_package = "rmddochelper",
  pb_recursive = TRUE, pb_edit = TRUE, pb_insert_include = TRUE)

Arguments

ps_path	file name including path of ODG graphics object file
ps_cwd	current working directory
ps_rmd_src	explicit file name of rmd-source file
ps_odg_template	name of the template to be used
ps_template_package	package from which template should be taken from
pb_recursive	flag whether missing directory should be created
pb_edit	flag to indicate whether odg file should be opened
pb_insert_include	flag indicating whether graphic include command should be inserted into rmd source file

Value

s_odg_trg name of and path to the created odg graphics file

Examples

## Not run: 
rmddochelper::use_odg_graphic(ps_odg_file = "my_odg_graphic.odg")

## End(Not run)

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