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

When the 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

asd;nda

default: []

settings.autogroups

number

automatically include categorical vars with 2-5 levels in the groups dropdown

default: 5

settings.autobins

boolean

sadasdas

default: true

##settings.nBins

number

asdksadas

default: 100

##settings.levelSplit

number

cutpoint for # of levels to use levelPlot() renderer

default: 5

Explorer

Coming soon

Charts

Coming soon