Configuration

Overview

The most straightforward way to customize an Safety Explorer Suite is by using a settings object whose properties describe the renderers. All defaults can be over-written by users when creating an AE Explorer.

settings

object

an object passed to safetyExplorerSuite() which controls the settings and appearance of the output.

settings.title

string

Optional title (e.g. study name) to be displayed in large text (using <h1> tag) above the nav.

** default:** null

settings.instructions

string

Optional instructions to be displayed in small text (using <small> tag) above the nav.

** default:** null

settings.renderers

array or string

An array listing which safety explorer renderers to include in the output. All available renderers are included by default. Valid options are:

• "aeexplorer"
• "ae-timelines"
• "safety-histogram"
• "safety-outlier-explorer"
• "paneled-outlier-explorer"
• "safety-results-over-time"
• "safety-shift-plot"
• "safety-eDISH"
• "web-codebook"

default: null

settings.chartSettings

object

An object defining the settings for the various charts in the safety explorer. There are several ways to configure settings:

• By default, all charts are created using their defaults settings (typically an empty object {}).
• Users can provide custom settings as a json object via chartSettings.custom
• Users can identify the location of an external settings object to be loaded vis chartSettings.location (Note that custom settings overwrite external settings if both are provided.)

Both user-defined chartSetting.custom objects and files specified by chartSettings.location must be structured as array of object. Each object must include a renderer_name field matching an option in settings.renderers. For example, the settings object below would add a site filter for the outlier explorer (all other charts would use their default settings):

var settings =  {
  chartSettings:{
    custom:[
      {
        renderer_name:"safety-outlier-explorer",
        filters:[{value_col:"site_name", label:"Site"}]
      {
    ]
  }
}

default: null

chartSettings.custom

array of objects

An array with one settings objects per renderer as described above. The renderer should be specified with a required renderer_name field for each object.

chartSettings.location

object

An object specifying the location of an array of objects (as described in chartSettings.custom above) to be loaded. The object has path field and a file field. If path is not specified, the \lib directory is used. If path is specified, chartSettings.custom is ignored.

settings.custom_settings

array of object

Deprecated in v0.4.0. Now automatically maps to settings.chartSettings.custom