-
Notifications
You must be signed in to change notification settings - Fork 2
/
settings-schema.json
187 lines (187 loc) · 8.32 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
{
"title": "settings",
"description": "JSON schema for the configuration of the CRF Heat Map",
"overview": "The most straightforward way to customize the CRF Heat Map is by using a configuration object whose properties describe the behavior and appearance of the table. Since the CRF Heat Map is a Webcharts `table` object, many default Webcharts settings are set in the [webchartsSettings.js file](https://github.com/RhoInc/crf-heat-map/blob/master/src/configuration/webchartsSettings.js) as [described below](#webcharts-settings). Refer to the [Webcharts documentation](https://github.com/RhoInc/Webcharts/wiki/Chart-Configuration) 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 CRF Heat Map to facilitate data mapping and other custom functionality. These custom settings are described in detail below and are set in the [rendererSettings.js file](https://github.com/RhoInc/crf-heat-map/blob/master/src/configuration/rendererSettings.js). All defaults can be overwritten by the passed configuration object.",
"version": "2.0.1",
"type": "object",
"properties": {
"site_col" : {
"title": "Site Column",
"description": "Specifies Site variable for nesting",
"type": "string",
"default": "sitename"
},
"id_col" : {
"title": "Subject ID Column",
"description": "Specifies Subject variable for nesting and subject-level export",
"type": "string",
"default": "subjectnameoridentifier"
},
"visit_col" : {
"title": "Visit Column",
"description": "Specifies Visit variable for nesting",
"type": "string",
"default": "folderinstancename"
},
"form_col" : {
"title": "Form Column",
"description": "Specifies Form variable for nesting",
"type": "string",
"default": "ecrfpagename"
},
"value_cols": {
"title": "CRF and Query Columns",
"description": "binary CRF flags and query frequencies that capture some status related to the case report form (CRF)",
"type": "array",
"items": {
"type": "object",
"properties":{
"col":{
"title":"Variable name",
"type":"string"
},
"type":{
"title":"Variable type",
"type":"string"
},
"denominator":{
"title":"Variable to subset proportion calculations with. Generally this impacts only the denominator (e.g. you want the % of signed forms out of those that needed to be signed, not out of any forms that could be signed). Only for use with type='crfs'.",
"type":"string"
},
"label":{
"title":"Table header label",
"type":"string"
},
"description":{
"title":"Variable description that appears when hovering over table header",
"type":"string"
}
}
},
"default": [
{"col": "is_partial_entry", "type": "crfs", "label": "Entered", "description": "Data have been submitted in the EDC system."},
{"col": "verified", "type" : "crfs", "denominator" : "needs_verification", "label": "Source Data Verified", "description" : "All required fields have source data verification complete in EDC."},
{"col": "ready_for_freeze", "type" : "crfs", "label": "Ready for Freeze", "description" : "All required cleaning is complete (e.g. SDV, queries resolved) and data are ready to be frozen in EDC."},
{"col": "is_frozen", "type" : "crfs", "label": "Frozen", "description": "Data have been frozen in the EDC system."},
{"col": "is_signed", "type" : "crfs", "denominator" : "needs_signature", "label": "Signed", "description" : "Data have been signed in the EDC system."},
{"col": "is_locked", "type" : "crfs", "label": "Locked", "description": "Data have been locked in the EDC system."},
{"col": "open_query_ct", "type" : "queries", "label": "Open", "description" : "Site has not responded to issue."},
{"col": "answer_query_ct", "type" : "queries", "label": "Answered", "description" : "Site has responded to issue, DM needs to review."}
]
},
"filter_cols": {
"title": "Variables to interactively filter chart with",
"description": "Variables ",
"type": "array",
"items": {
"type": "object",
"properties":{
"value_col":{
"title":"Variable Name",
"type":"string"
},
"label":{
"title":"Label",
"type":"string"
},
"multiple":{
"title":"Multi-select",
"type": "boolean",
"default":false
},
"subject_export":{
"title":"Include variable in subject-level export",
"type":"boolean",
"default":false
}
}
},
"default": [
{
"value_col": "sitename",
"label": "Site"
},
{
"value_col": "subjectnameoridentifier",
"label": "Subject ID"
},
{
"value_col": "foldername",
"label": "Folder"
},
{
"value_col": "architectformname",
"label": "Form"
},
{
"value_col": "status",
"label": "Subject Status",
"multiple": true,
"subject_export": true
},
{
"value_col": "subjfreezeflg",
"label": "Subject Freeze Status",
"subject_export": true
},
{
"value_col": "subset1",
"label": "Subset 1"
},
{
"value_col": "subset2",
"label": "Subset 2"
},
{
"value_col": "subset3",
"label": "Subset 3"
}
]
},
"visit_order_col" : {
"title": "Visit Order Column",
"description": "Variable for determining order of Visit column",
"type": "string",
"default": "folder_ordinal"
},
"form_order_col" : {
"title": "Form Order Column",
"description": "Variable for determining order of Form column",
"type": "string",
"default": "form_ordinal"
},
"default_nesting" : {
"title": "Default Nesting",
"description": "Variables to summarize chart by on initial rendering",
"type": "array",
"items": {
"type": "string"
},
"default": ["site_col", "id_col"]
},
"display_fraction": {
"title": "Display Fractions",
"description": "Displays fractions for crf values alongside calculated percentages",
"type": "boolean",
"default": false
},
"expand_all": {
"title": "Expand All Rows",
"description": "Expands all nests so that no rows are hidden",
"type": "boolean",
"default": false
},
"sliders": {
"title": "Enable Slider Filters",
"description": "Replaces input boxes with sliders for filtering rows",
"type": "boolean",
"default": false
},
"max_rows_warn": {
"title": "Maximum Number of Rows Before Warning User",
"description": "Number of rows above which the user will be prompted for confirmation when expanding rows",
"type": "number",
"default": 10000
}
}
}