Configuration

Overview

The most straightforward way to customize a codebook 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 a codebook.

settings

object

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

settings.filters

array or character

Specifies which data columns should be used to create filters. For example, filters:["Sex","Age", "Site"] would create filters for the 3 specified variables. If no values are specified (as is the default), filters are created using the autofilters setting described below.

default: []

settings.autofilter

number

Ignored when settings.filters is specified.When no filters are specified by the user, filters are created for all categorical variables with least 2 unique levels, but no more than than setting.autofilter unique levels. So, by default filters are created for categorical variables with 2-10 levels.

default: 10

settings.groups

array or character

Specifies with data columns should be included in the "group by" drop down. If no values are specified (as is the default), the dropdown is populated using the autogroups setting described below.

default: []

settings.autogroups

number

Ignored when settings.groups is specified. When no groups are specified by the user, the group dropdown is populated with all categorical variables with least 2 unique levels, but no more than than setting.autogroup unique levels. So, by default, the group dropdown includes categorical variables with 2-10 levels.

default: 5

settings.autobins

boolean

Specifies whether the number of bins for each continuous variable should be calculated using the Freedman-Diaconis rule or whether a set number of bins should be used for all variables.

default: true

settings.nBins

number

Ignored when settings.autobins is set to true. Specifies the number of bins used in each histogram.

default: 100

settings.levelSplit

number

Specifies the number of levels in a categorical variable above which the charts.levelPlot renderer should be used instead the charts.barchart renderer.

default: 5

Explorer

Coming soon

Charts

Coming soon