-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.html
531 lines (447 loc) · 19.5 KB
/
README.html
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
<title></title>
<style type="text/css">
/*
:Author: David Goodger ([email protected])
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document">
<div class="section" id="fludashboard">
<h1>fludashboard</h1>
<a class="reference external image-reference" href="https://pypi.python.org/pypi/fludashboard"><object data="https://img.shields.io/pypi/v/fludashboard.svg" type="image/svg+xml">https://img.shields.io/pypi/v/fludashboard.svg</object></a>
<a class="reference external image-reference" href="https://travis-ci.org/FluVigilanciaBR/fludashboard"><object data="https://img.shields.io/travis/FluVigilanciaBR/fludashboard.svg" type="image/svg+xml">https://img.shields.io/travis/FluVigilanciaBR/fludashboard.svg</object></a>
<a class="reference external image-reference" href="https://fludashboard.readthedocs.io/en/latest/?badge=latest"><img alt="Documentation Status" src="https://readthedocs.org/projects/fludashboard/badge/?version=latest" /></a>
<a class="reference external image-reference" href="https://pyup.io/repos/github/FluVigilanciaBR/fludashboard/"><object data="https://pyup.io/repos/github/FluVigilanciaBR/fludashboard/shield.svg" type="image/svg+xml">Updates</object></a>
<p>Flu Dashboard</p>
<p>Flu Dashboard is an initiative to monitor and provide alert levels for Severe Acute Respiratory Infections (SARI)
notifications registered at SINAN, the Brazilian Notifiable Diseases Information System (www.saude.gov.br/sinan).
Data is provided for each Brazilian State as well as by influenza-like illnessess (ILI) regions.</p>
<p>This is a product of the joint work between researchers at the Scientific Computation Program at Oswaldo Cruz
Foundation (Fiocruz, PROCC), School of Applied Mathematics at Fundação Getúlio Vargas (EMAp-FGV), both from Rio de
Janeiro, Brazil, and the Inluenza Work Force at the Health Surveillance Secretariat of the Brazilian Ministry of
Health (GT-Influenza, SVS, MS).</p>
<ul class="simple">
<li>Free software: GNU General Public License v3</li>
<li>Documentation: <a class="reference external" href="https://fludashboard.readthedocs.io">https://fludashboard.readthedocs.io</a>.</li>
</ul>
<div class="section" id="features">
<h2>Features</h2>
<ul class="simple">
<li>Nowcast of weekly incidence;</li>
<li>Activity thresholds;</li>
<li>Age distribution of notified cases;</li>
<li>Seasonal activity level;</li>
<li>Historical incidence curves.</li>
</ul>
</div>
</div>
<div class="section" id="deployment">
<h1>Deployment</h1>
<p>To deploy FluDashboard Prototype use conda package (that will create a conda environment called <em>fludashboard</em>):</p>
<pre class="code shell literal-block">
conda config --set always_yes yes --set changeps1 no
conda config --add channels conda-forge
conda update --all
conda env create -f requirements -n fludashboard
</pre>
<p>Change to the new environment created:</p>
<pre class="code shell literal-block">
<span class="name builtin">source</span> activate fludashboard
</pre>
<p>Optionally, the deployment can be done into a docker container. To create a new container with conda environment:</p>
<pre class="code shell literal-block">
docker pull continuumio/anaconda3
</pre>
</div>
<div class="section" id="running-the-app">
<h1>Running the app</h1>
<p>To run the app just type in the terminal (into fludashboard/fludashboard directory):</p>
<pre class="code shell literal-block">
python app.py
</pre>
<p>The application will be available on the port 5000. To set a custom port, use -p argument with the port number:</p>
<pre class="code shell literal-block">
python app.py -p 9000
</pre>
</div>
<div class="section" id="functionality">
<h1>Functionality</h1>
<p>FluDashboard presents activity levels and incidence information time series by epidemiological week as well as by
epidemiological season.
Those two can be accessed by the <strong>"Detalhado (semana)" (i.e, detailed)</strong> and the <strong>"Resumido (ano)" (i.e, summary)</strong> view. Each view is composed by 4 panels:</p>
<ul class="simple">
<li>Country map</li>
<li>Incidence chart</li>
<li>Incidence table</li>
<li>Age and gender distribution</li>
</ul>
<p>In each, information can be displayed by State or by Region.</p>
<div class="section" id="detalhado-weekly-activity-information-view">
<h2>Detalhado (weekly activity information) view:</h2>
<ul class="simple">
<li>Country map (upper left)</li>
</ul>
<blockquote>
<p>Each State/Region is colored according to selected week activity level:</p>
<ul class="simple">
<li>Low activity (green): incidence below epidemic threshold;</li>
<li>Epidemic activity (yellow): incidence above epidemic threshold and below high incidence threshold;</li>
<li>High activity (orange): incidence above high and below very high incidence threshold;</li>
<li>Very high activity (red): incidence above very high incidence threshold.</li>
</ul>
</blockquote>
<ul class="simple">
<li>Incidence chart (upper right)</li>
</ul>
<blockquote>
<p>This panel presents the reported incidence time series (black solid line) for the corresponding season, with an horizontal marker indicating the selected epidemiological week. Incidence is reported per 100 thousand individuals. Incidence estimation, when possible, is shown as a red solid line along with 95% confidence interval as dotted red lines. The activity level probability is also presented as text on the upper left corner. Map color correspond to activity level with highest probability. Along with reported and estimated incidence, the system presents the following activity thresholds, estimated based on historical activity at each State/Region:</p>
<ul class="simple">
<li>Pre-epidemic threshold (blue dashed line): activity level which indicates, when crossed, the beginning of sustained transmission for the current season. After crossing this threshold, incidence is expected to present steady increase (subject to fluctuations);</li>
<li>High activity threshold (green dashed line): activity level above which incidence is considered high for that location. Calculated based on the estimated 90 percentile of historical activity distribution.</li>
<li>Very high activity threshold (red dashed line): activity level above which incidence is considered high for that region. Calculated based on the estimated 97.5 percentile of historical activity distribution.</li>
</ul>
</blockquote>
<ul class="simple">
<li>Incidence chart background color scheme</li>
</ul>
<blockquote>
<p>The background color of the incidence time series represent the typical activity level per week. That is, the historical incidence distribution per week. It allows for identification of typical seasonal pattern, making easier to identify the period of higher activity (epidemic period).</p>
<ul class="simple">
<li>Weekly low activity (green shade): activity below the 10% percentile in each week;</li>
<li>Weekly low to average activity (yellow shade): activity between the 10% and 50% percentiles in each week;</li>
<li>Weekly average to high activity (oragne shade): activity between the 50% and 90% percentile in each week;</li>
<li>Weekly high activity (red shade): activity above 90% percentile in each week.</li>
</ul>
<p>When the incidence in a given week is within the high activity region (red background), even if below the incidence thresholds, it indicates that for that particular week the incidence is unusually high. This information is useful for detecting seasons where the epidemic period starts earlier than usual, for instance. Check activity for season 2016 for example.</p>
</blockquote>
<ul class="simple">
<li>Incidence table (lower left)</li>
</ul>
<blockquote>
<p>Incidence for the corresponding State/Region at selected epidemiological week, along with 90% confidence interval when based on estimation. Along with the name of the State/Region and incidence, this table also presents selected data current status:</p>
<ul class="simple">
<li>Stable: reported data is considered to be sufficiently close to total number of notifications. Reported values are expected to suffer minor updates in the future, if any;</li>
<li>Estimated: reported data is based on estimation of the digitization opportunity. That is, based on the number of notifications already entered in the system (incomplete) and typical delay between notification at health unit and digitization in the system. Reported values are expected to change in the future, becoming stable after a few weeks;</li>
<li>Incomplete: reported data is not yet stable due to digitization opportunity pattern in the selected State/Region and our system is not able to provide reliable estimates. Data is subject to significant changes in the future, becoming stable after a few weeks.</li>
</ul>
</blockquote>
<ul class="simple">
<li>Age and gender distribution</li>
</ul>
<blockquote>
<p>Reported incidence (without estimation) bar chart by gender and age bracket.</p>
<ul class="simple">
<li>Females (blue);</li>
<li>Males (orange);</li>
<li>Total population (green).</li>
</ul>
<p>Distributions are subject to future updates as described in the incidence table. Distribution in this panel does not use estimations, being always the currently reported distribution, either stable or incomplete.</p>
</blockquote>
</div>
<div class="section" id="resumido-seasonal-activity-view">
<h2>Resumido (seasonal activity) view:</h2>
<p>This view uses detailed activity levels to report the seasonal one.</p>
<ul class="simple">
<li>Country map (upper left)</li>
</ul>
<blockquote>
<p>Each State/Region is colored according to selected week activity level:</p>
<ul class="simple">
<li>Low activity (green): incidence below epidemic threshold during the whole season</li>
<li>Epidemic activity (yellow): incidence has crossed the epidemic threshold at least once, but never crossed high incidence threshold;</li>
<li>High activity (orange): weekly incidence has been reported above high or very high incidence threshold between 1 to 4 weeks;</li>
<li>Very high activity (red): weekly incidence has been reported above high or very high incidence threshold for 5 weeks or more.</li>
</ul>
</blockquote>
<ul class="simple">
<li>Incidence chart (upper right)</li>
</ul>
<blockquote>
<p>This panel presents the reported incidence time series (black solid line) for the corresponding season. Incidence is reported per 100 thousand individuals. Incidence estimation, when possible, is shown as a red solid line along with 95% confidence interval as dotted red lines. The activity level probability is also presented as text on the upper left corner. Map color correspond to activity level with highest probability. Along with reported and estimated incidence, the system presents the following activity thresholds, estimated based on historical activity at each State/Region:</p>
<ul class="simple">
<li>Pre-epidemic threshold (blue dashed line): activity level which indicates, when crossed, the beginning of sustained transmission for the current season. After crossing this threshold, incidence is expected to present steady increase (subject to fluctuations);</li>
<li>High activity threshold (green dashed line): activity level above which incidence is considered high for that location. Calculated based on the estimated 90 percentile of historical activity distribution.</li>
<li>Very high activity threshold (red dashed line): activity level above which incidence is considered high for that region. Calculated based on the estimated 97.5 percentile of historical activity distribution.</li>
</ul>
</blockquote>
<ul class="simple">
<li>Incidence table (lower left)</li>
</ul>
<blockquote>
<p>Incidence for the corresponding State/Region for selected season up to latest report. Along with the name of the State/Region and incidence, this table also presents selected data current status:</p>
<ul class="simple">
<li>Stable: reported data is considered to be sufficiently close to total number of notifications. Reported values are expected to suffer minor updates in the future, if any;</li>
<li>Incomplete: reported data is not yet stable due to digitization opportunity pattern in the selected State/Region. Data is subject to significant changes in the future, becoming stable after a few weeks.</li>
</ul>
</blockquote>
<ul class="simple">
<li>Age and gender distribution</li>
</ul>
<blockquote>
<p>Reported incidence bar chart by gender and age bracket for the selected season.</p>
<ul class="simple">
<li>Females (blue);</li>
<li>Males (orange);</li>
<li>Total population (green).</li>
</ul>
<p>Distributions are subject to future updates as described in the incidence table. Distribution in this panel does not use estimations, being always the currently reported distribution, either stable or incomplete.</p>
</blockquote>
</div>
</div>
</div>
</body>
</html>