-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsettings-schema.json
277 lines (277 loc) · 11.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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
{
"title": "settings",
"description": "JSON schema for the configuration of the participant-visit-listing",
"overview": "The most straightforward way to customize the Participant Visit Listing is by using a configuration object whose properties describe the behavior and appearance of the displays. The Participant Visit Listing object contains Webcharts both `table` and `chart` objects, and the user settings will overwrite the default settings of each of those objects. Refer to the Webcharts [table](https://github.com/RhoInc/Webcharts/wiki/Table-Configuration) and [chart](https://github.com/RhoInc/Webcharts/wiki/Chart-Configuration) configuration wikis for more details on these settings.\nIn addition to the standard Webcharts settings several custom settings not available in the base Webcharts library have been added to the Participant Visit Listing to facilitate data mapping and other custom functionality. These custom settings are described in detail below. All defaults can be overwritten by users.",
"version": "1.5.1",
"type": "object",
"data-guidelines": "The Participant Visit Listing accepts [JSON](https://en.wikipedia.org/wiki/JSON) data of the format returned by [`d3.csv()`](https://github.com/d3/d3-3.x-api-reference/blob/master/CSV.md). The collection of displays visualizes clinical schedule of events data with **one row per participant per visit** plus the required variables specified below.",
"data-structure": "one record per participant per visit",
"properties": {
"site_col": {
"title": "Site",
"description": "name of variable that captures site",
"default": "site_name",
"type": "string",
"data-mapping": true,
"data-type": "string",
"required": t
},
"id_col": {
"title": "Participant ID",
"description": "name of variable that captures participant ID",
"default": "subjectnameoridentifier",
"type": "string",
"data-mapping": true,
"data-type": "string",
"required": true
},
"id_status_col": {
"title": "Participant Status",
"description": "name of variable that captures participant status",
"default": "subject_status",
"type": "string",
"data-mapping": true,
"data-type": "string",
"required": true
},
"visit_col": {
"title": "Visit",
"description": "name of variable that captures visit name",
"default": "visit_name",
"type": "string",
"data-mapping": true,
"data-type": "string",
"required": true
},
"visit_abbreviation_col": {
"title": "Visit Abbreviation",
"description": "name of variable that captures abbreviated visit name",
"default": "visit_abbreviation",
"type": "string",
"data-mapping": true,
"data-type": "string",
"required": true
},
"visit_order_col": {
"title": "Sort Order of Visit",
"description": "name of variable that captures sort order of visit",
"default": "visit_number",
"type": "string",
"data-mapping": true,
"data-type": "number",
"required": false
},
"visit_date_col": {
"title": "Date of Visit",
"description": "name of variable that captures date of visit",
"default": "visit_date",
"type": "string",
"data-mapping": true,
"data-type": "string",
"required": true
},
"visit_day_col": {
"title": "Study Day of Visit",
"description": "name of variable that captures study day of visit",
"default": "visit_day",
"type": "string",
"data-mapping": true,
"data-type": "string",
"required": true
},
"visit_status_col": {
"title": "Visit Status",
"description": "name of variable that captures status of visit",
"default": "visit_status",
"type": "string",
"data-mapping": true,
"data-type": "string",
"required": true
},
"visit_status_order_col": {
"title": "Sort Order of Visit Status",
"description": "name of variable that captures sort order of visit status",
"default": "visit_status_order",
"type": "string",
"data-mapping": true,
"data-type": "number",
"required": false
},
"visit_text_col": {
"title": "Listing Cell Text",
"description": "name of variable that captures text to be printed in listing cells",
"default": "visit_text",
"type": "string",
"data-mapping": true,
"data-type": "string",
"required": false
},
"visit_status_color_col": {
"title": "Visit Status Color",
"description": "name of variable that captures desired color of visit status",
"default": "visit_status_color",
"type": "string",
"requirement": "color must be hex RGB",
"data-mapping": true,
"data-type": "string",
"required": false
},
"visit_status_description_col": {
"title": "Description of Visit Status",
"description": "name of variable that captures a more detailed description of the visit status",
"default": "visit_status_description",
"type": "string",
"data-mapping": true,
"data-type": "string",
"required": false
},
"visit_expectation_pattern": {
"title": "Visit Expectation Text Pattern",
"description": "this string will be converted to a regular expression that will identify visit statuses that represent overdue or future visits",
"default": "/expect|future|overdue/i",
"type": "string"
},
"visit_exclusion_pattern": {
"title": "Visit Exclusion Text Pattern",
"description": "this string will be converted to a regular expression that will identify unscheduled visits, e.g. unscheduled, repeat, and early termination visits",
"default": "/unscheduled|early termination|repeat/i",
"type": "string"
},
"visit_overdue_pattern": {
"title": "Visit Overdue Text Pattern",
"description": "this string will be converted to a regular expression that will identify overdue visits",
"default": "/overdue/i",
"type": "string"
},
"visit_status_exclusion_col": {
"title": "Visit Status Exclusion Flag",
"description": "name of variable that identifies visit statuses to exclude from visit status legend",
"default": "plot_exclude",
"type": "string",
"data-mapping": true,
"data-type": "string",
"required": false
},
"visit_status_exclusion_value": {
"title": "Visit Status Exclusion Value",
"description": "value of variable that identifies visit statuses to exclude from visit status legend",
"default": "Yes",
"type": "string"
},
"chart_layout": {
"title": "Chart Layout",
"description": "layout of charts, either each in their own tab or side-by-side in a single tab",
"default": "tabbed",
"type": "string",
"enum": [
"tabbed",
"side-by-side"
]
},
"active_tab": {
"title": "Initially Active Tab",
"description": "name of tab that is displayed initially",
"default": "Visit Chart",
"type": "string",
"enum": [
"Visit Chart",
"Study Day Chart",
"Charts",
"Listing"
]
},
"date_format": {
"title": "Visit Date Format",
"description": "a strptime specification of time format directives, used to parse visit date",
"default": "%Y-%m-%d",
"type": "string"
},
"abbreviate_visits": {
"title": "Abbreviate Visits?",
"description": "controls whether full or abbreviated visit names display in x-axis of visit chart and column headers of listing",
"default": true,
"type": "boolean"
},
"display_cell_text": {
"title": "Display Listing Cell Text?",
"description": "controls the display of the listing, either as a heat map or as a listing",
"default": true,
"type": "boolean"
},
"toggle_cell_text": {
"title": "Toggle Listing Cell Text?",
"description": "controls the display of the listing cell text toggle",
"default": false,
"type": "boolean"
},
"chart_margin": {
"title": "Chart Margins",
"description": "controls the margins around the chart canvas, e.g. for the axes; modify as needed to create space for rotated x-axis tick labels",
"properties": {
"top": {
"title": "Top Margin",
"description": "space above the chart canvas",
"default": 100,
"type": "number"
},
"right": {
"title": "Right Margin",
"description": "space to the right of the chart canvas",
"type": "number"
},
"bottom": {
"title": "Bottom Margin",
"description": "space below the chart canvas; if unspecified, imputed to fit x-axis",
"default": 100,
"type": "number"
},
"left": {
"title": "Left Margin",
"description": "space to the left of the chart canvas; if unspecified, imputed to fit y-axis",
"type": "number"
}
},
"type": "object"
},
"filter_cols": {
"title": "Custom Filter Variables",
"description": "custom filter variables in addition to site, participant status, and number of overdue visits",
"type": "array",
"items": {
"type": "object",
"properties": {
"value_col": {
"title": "Name of Variable",
"type": "string"
},
"label": {
"title": "Description of Variable",
"type": "string"
},
"multiple": {
"title": "Multiselect?",
"type": "boolean",
"default": false
}
}
},
"default": [
{
"value_col": "subset1",
"label": "Analysis Subset 1"
},
{
"value_col": "subset2",
"label": "Analysis Subset 2"
},
{
"value_col": "subset3",
"label": "Analysis Subset 3"
}
],
"data-mapping": true,
"data-type": "string",
"required": false
}
}
}