Configuration

Overview

The most straightforward way to customize an AE Explorer is by using a settings object whose properties describe the chart's behavior and appearance. Parameters for the settings object are described in detail below. All defaults can be over-written by users when creating an AE Explorer.

settings

object

Objects passed to aeTable() which controls the settings and appearance of the output. The sections below describe each aeexplorer setting as of version 3.4.0.

settings.variables

object

an object that specifies how to map columns from the data file to the chart settings

settings.variables.id

string

ID

default: "USUBJID"

settings.variables.major

string

Major Category

default: "AEBODSYS"

settings.variables.minor

string

Minor Category

default: "AEDECOD"

settings.variables.group

string

Group

default: "ARM"

settings.variables.details

array

Details

default: none

settings.variables.filters

array

Filters

default:

[
  {
    "value_col": "AESER",
    "label": "Serious?",
    "type": "event",
    "start": null
  },
  {
    "value_col": "AESEV",
    "label": "Severity",
    "type": "event",
    "start": null
  },
  {
    "value_col": "AEREL",
    "label": "Relationship",
    "type": "event",
    "start": null
  },
  {
    "value_col": "AEOUT",
    "label": "Outcome",
    "type": "event",
    "start": null
  }
]

settings.variableOptions

object

An object that specifies valid options for the primary variable mappings (id, major, minor and groups). When 2+ options are specified for any given mapping, a control is drawn so that the user can interactively update chart to use any of the options.

settings.variableOptions.major

array

Major variable options

default: none

settings.variableOptions.minor

array

Minor variable options

default: none

settings.variableOptions.group

array

Group variable options

default: none

settings.variableOptions.id

array

ID variable options

default: none

settings.groups

array

An array specifying which levels of settings.variables.groups will appear as columns in the table.

default: none

settings.colors

array

an array of colors that control the color of each group in the table

default:

[
  "#377EB8",
  "#4DAF4A",
  "#984EA3",
  "#FF7F00",
  "#A65628",
  "#F781BF",
  "#E41A1C"
]

settings.defaults

object

an object containing default settings regarding appearance of the tables

settings.defaults.placeholderFlag

object

Placeholder Rows Definition

settings.defaults.maxPrevalence

number

Maximum Prevelance

default: 0

settings.defaults.maxGroups

number

Maximum Group Count

default: 6

settings.defaults.totalCol

boolean

Show Total Column?

default: true

settings.defaults.diffCol

boolean

Show Difference Column?

default: true

settings.defaults.prefTerms

boolean

Show All Preferred Terms?

default: false

settings.defaults.summarizeBy

string

Data Summary Type

default: "participant"

settings.defaults.webchartsDetailsTable

boolean

Data Summary Type

default: false

settings.plotSettings

object

Object to specify the appearance of the plots embedded in the table rows.

settings.plotSettings.h

number

Height

default: 15

settings.plotSettings.w

number

Width

default: 200

settings.plotSettings.r

number

Radius

default: 7

settings.plotSettings.margin

object

Dot Plot Margins

settings.plotSettings.diffMargin

object

Difference Plot Margins

settings.validation

boolean

adds a link to download the summarized data in a comma-separated format

default: false