Configuration

Overview

The most straightforward way to customize an AE Table 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

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

settings.variables

object

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

variables.id

string

participant ID variable name

default: 'USUBJID'

variables.major

string

higher-level term variable name

default: 'AEBODSYS'

variables.minor

string

lower-level term variable name

default: 'AEDECOD'

variables.group

string

group variable name, each value of which displays in its own column in the AE table unless settings.groups is defined.

default: 'ARM'

variables.details

array of object

an array listing each variable to display in the detail listing; if empty or unspecified, all variables in input data file will appear in detail listing

default: []

details[].value_col

character

Field in the data object to be in the details table.

details[].label

character

Label for the details table header.

variables.filters

array

An array of objects specifying categorical data filters to be included with the histogram.

default:

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

filters[].value_col

character

Field in the data object to be used for the filter. All values treated as categorical.

filters[].label

character

Label for the filter.

filters[].type

character

Specify whether the filter applies to participants or events, like so:

var settings = 
filters: [
  {'value_col': 'SITEID','label': 'Site ID','type': 'participant' },
  {'value_col': 'AESER','label': 'Serious AE?','type': 'event' }
]

settings.groups

array of objects

An array specifying which levels of settings.variables.groups will appear as columns in the table. If more than config.maxGroups levels are specified the chart throw an error and will not render. The array should be formatted as objects with a key value matching the group level (e.g. [{key:"Placebo"},{"key":"Treatment A"}])

default: [] (all possible levels are used)

settings.defaults

an array of default settings regarding appearance of the tables

defaults.maxPrevalence

number

filters out any higher- and lower-level rows without at least one group rate above specified value

defaults.diffCol

boolean

specifies whether or not to render a column of graphical differences

default: 'Show'

defaults.totalCol

boolean

specifies whether or not to render a column showing overall rates across all groups

default: true

defaults.prefTerms

boolean

specifies whether or not to initially display all lower-level rows

default: false

defaults.maxGroups

number

Maximum number of group levels allowed. Display gets ugly with more than a handful of columns, and browser performance deteriorates quickly (and may lock up) after a few dozen levels.

default: 6

defaults.placeholderFlag

object

Object to specify how to identify placeholder rows for participants with no AEs.

default: {'value_col':"AEBODSYS", 'values':["NA"]}

settings.plotSettings

object

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

plotSettings.h

number

height of the plot svg in pixels

default: 15

plotSettings.w

number

height of the plot svg in pixels

default: 200

plotSettings.r

number

radius of the plotted points in pixels

default: 7

plotSettings.margin

object

object specifying the dot plot margins

default: {'left':40, 'right':40}

plotSettings.diffMargin

object

object specifying the margins for the difference diamonds plot

default: {'left':5, 'right':5}

settings.validation

boolean

Experimental setting that facilitates creation a comma-delimited data set of the current view of the data.

default: false