Skip to contents

Functions to manage schemes

Source: R/scheme_make.R
scheme_make.Rd

Functions to manage schemes

Usage

scheme_make(
  schemeDefinition,
  examples = NULL,
  install_R_package = NULL,
  path = ".",
  overwrite = FALSE,
  index_template = NULL
)

Arguments

schemeDefinition

path to the .xlsx file containing the definition of the scheme as well as the example

examples

character vector of directories which should be included as examples. The name of the director will be the name of the example. The example can contain a file with the name EXAMPLENAME.html where EXAMPLENAME is the name of the folder. This html will abe automatically opened when calling make_example("EXAMPLENAME") Otherwise there are no restrictions to formats.

install_R_package

path to the R script to install the R package. If NULL, no command is given.

path

where the final scheme definition should be created.

overwrite

if TRUE, the scheme definition in path will be overwritten.

index_template

the index template file which can be added

Value

fully qualified path to the created scheme