makeChartConfig {safetyGraphics}

Make Chart Config

Description

Converts YAML chart configuration files to an R list and binds workflow functions. See the vignette about creating custom charts for more details.

Usage

makeChartConfig(
  dirs,
  packages = "safetyCharts",
  packageLocation = "config",
  sourceFiles = FALSE
)

Arguments

dirs

path to one or more directories containing yaml config files (relative to working directory)

packages

installed packages names containing yaml config files in the /inst/packageLocation folder

packageLocation

inst folder where yaml config files (and possibly R functions referenced in yaml workflow) are located in packages

sourceFiles

boolean indicating whether to source all R files found in dirs.

Value

returns a named list of charts derived from YAML files. Each element of the list contains information about a single chart, and has the following parameters:

• "env" Environment for the chart. Must be set to "safetyGraphics" or the chart is dropped.

• "name" Name of the chart. Also the name of the element in the list - e.g. charts$aeExplorer$name is "aeExplorer"

• "label" Short description of the chart

• "type" Type of chart; options are: 'htmlwidget', 'module', 'plot', 'table', 'html' or 'plotly'.

• "domain" Data domain. Should correspond to one or more domains in meta

• "package" Primary package (if any). Other packages can be loaded directly in workflow functions.

• "order" Integer order in which to display the chart. If order is a negative number, the chart is dropped.

• "export" Logical flag indicating whether the chart can be exported to an html report. True by default, except for when type is module.

• "path" Path to YAML file

• "links" Named list of link names/urls to be shown in the chart header.

• "workflow" List of functions names used to render chart. See vignette for details.

• "functions" List of functions for use in chart renderering. These functions must be located in the global environment or package field of the YAML config. Function names must include either the name or workflow fields of the YAML config.