-
Notifications
You must be signed in to change notification settings - Fork 5
/
settings-schema.json
226 lines (225 loc) · 8.7 KB
/
settings-schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
{
"description": "",
"overview": "The most straightforward way to customize a codebook is to define a settings object whose properties describe the codebook's behavior and appearance. The settings object can be passed as the second argument to `webcodebook.createCodebook()` (or its alias `webcodebook.createChart()`). All defaults can be overwritten by users when creating a codebook. Parameters for the settings object are described in detail below.",
"version": "1.7.1",
"type": "object",
"properties": {
"filters": {
"type": "array",
"title": "Filters",
"description": "an array of filter variables; by default variables with 10 or fewer levels become filters",
"items": {
"type": "object",
"properties": {
"value_col": {
"type": "string",
"title": "Variable Name",
"description": "the name of the filter variable"
},
"label": {
"type": "string",
"title": "Variable Label",
"description": "a label that describes the filter variable"
}
}
}
},
"groups": {
"type": "array",
"title": "Groups",
"description": "an array of group variables; by default variables with 5 or fewer levels become group options",
"items": {
"type": "object",
"properties": {
"value_col": {
"type": "string",
"title": "Variable Name",
"description": "the name of the group variable"
},
"label": {
"type": "string",
"title": "Variable Label",
"description": "a label that describes the group variable"
}
}
}
},
"variableLabels": {
"type": "array",
"title": "Variable Labels",
"description": "an array of variable objects with both the variable name and a brief description of the variable",
"items": {
"type": "object",
"properties": {
"value_col": {
"type": "string",
"title": "Variable Name",
"description": "the name of the variable"
},
"label": {
"type": "string",
"title": "Variable Label",
"description": "a label that describes the variable"
}
}
}
},
"variableTypes": {
"type": "array",
"title": "Variable Type",
"description": "an array of variable objects with both the variable name and the type of the variable",
"items": {
"type": "object",
"properties": {
"value_col": {
"type": "string",
"title": "Variable Name",
"description": "the name of the variable"
},
"type": {
"type": "string",
"title": "Variable Type",
"description": "a label that describes the variable",
"enum": [
"continuous",
"categorical"
]
}
}
}
},
"hiddenVariables": {
"type": "array",
"title": "Hidden Variables",
"description": "an array of variables that will be hidden throughout the codebook",
"items": {
"type": "string"
}
},
"meta": {
"type": "array",
"title": "Variable Metadata",
"description": "an array of variable metadata",
"items": {
"type": "object",
"properties": {
"value_col": {
"type": "string",
"title": "Variable Name",
"description": "the name of the variable"
},
"label": {
"type": "string",
"title": "Variable Label",
"description": "a label that describes the variable"
},
"filter": {
"type": "boolean",
"title": "Filter?",
"description": "includes variable as a filter"
},
"group": {
"type": "boolean",
"title": "Group?",
"description": "includes variable as a group option"
},
"type": {
"type": "string",
"title": "Variable Type",
"description": "the type of data contained in the variable"
}
}
}
},
"autogroups": {
"type": "number",
"title": "Level Cutoff to Choose Group Variables",
"description": "the number of levels in a variable over which the variable will not be added as a group option",
"default": 5
},
"autofilter": {
"type": "number",
"title": "Level Cutoff to Choose Filter Variables",
"description": "the number of levels in a variable over which the variable will not be added as a filter",
"default": 10
},
"autobins": {
"type": "boolean",
"title": "Automatically Choose Number of Bins in Histogram?",
"description": "the number of bins in histograms will be determined algorithmically based on the range of the variable and the number of observations",
"default": true
},
"nBins": {
"type": "number",
"title": "Number of Bins in Histogram",
"description": "the number of bins in which to split out each continuous variable into",
"default": 100
},
"levelSplit": {
"type": "number",
"title": "Level Cutoff to Choose Horizontal or Vertical Bar Charts",
"description": "the number of levels in a variable over which the variable will be summarized with a vertical bar chart as opposed to a horizontal bar chart",
"default": 5
},
"controlVisibility": {
"type": "string",
"title": "Control Visibility",
"description": "the initial state of the display of the controls",
"default": "visible",
"enum": [
"hidden",
"minimized",
"visible"
]
},
"chartVisibility": {
"type": "string",
"title": "Chart Visibility",
"description": "the initial state of the display of the charts",
"default": "minimized",
"enum": [
"hidden",
"minimized",
"visible"
]
},
"tabs": {
"type": "array",
"title": "Codebook Tabs",
"description": "an array of the tabs displayed in the codebook",
"default": [
"codebook",
"listing",
"chartMaker",
"settings"
],
"items": {
"type": "string",
"enum": [
"codebook",
"listing",
"chartMaker",
"settings",
"files"
]
}
},
"dataName": {
"type": "string",
"title": "Data Name",
"description": "the name of the data file summarized in the codebook",
"default": ""
},
"whiteSpaceAsMissing": {
"type": "boolean",
"title": "White space as missing",
"description": "White space will be treated as missing values",
"default": true
},
"missingValues": {
"type": "array",
"title": "missing Values",
"description": "Array of missing values. Note that json schema does not support the default value of [null, NaN, undefined]"
}
}
}