Lihimi Tɛmplet:Medical cases chart/doc ni yi shɛli na

{{Documentation subpage}}
{{Lua|Module:Medical cases chart}}

== Description ==

This template should be used for all outbreak, epidemic and pandemic medical cases charts based on {{tl|Bar box}} to maintain consistency. It displays horizontal bars for up to 5 different classifications of cases for each valid date or interval. It offers two columns to make numbers explicit and to show relative or absolute changes. It also uses a sophisticated toggling system to control the visualization of data rows across many months or years. It is designed to be flexible, but still standardizes some parts of the chart. This template should be [[Transclusion|transcluded]] in other templates, '''NOT''' in article pages. Suggest features in the [[Template talk:Medical cases chart|talk page]] or code them if they're neither controversial nor incompatibility prone.

== Usage ==

{{pre|1=
{{((}}Medical cases chart
{{!}}float      = ''side of the page where the chart will be located'' (left{{!}}center{{!}}right{{!}}none) [optional, defaults to: right]

{{!}}barwidth   = ''width of the stacked bars area'' (thin{{!}}medium{{!}}wide{{!}}auto)                    [optional, defaults to: medium]
{{!}}numwidth   = ''max width of the numbers in the right columns'' (AA or AAAA)←(n{{!}}t{{!}}m{{!}}w{{!}}x{{!}}d)  [suggested, defaults to: mm; see info below]
{{!}}rowheight  = ''height of each bar in multiples of the text height''                        [optional, defaults to: 1.6]

{{!}}pretitle   = ''text at the beginning of the title''                                        [optional]
{{!}}disease    = ''name of the disease''
{{!}}location   = ''location of the outbreak the chart is showing''
{{!}}location2  = ''broader location such as state/province or country''                        [optional]
{{!}}location3  = ''broadest location such as country''                                         [optional]
{{!}}posttitle  = ''text at the end of the title''                                              [optional]
{{!}}outbreak   = ''name of the main outbreak for the links of the {{tl|navbar}}''                 [see info below]

{{!}}recoveries = ''whether to display recoveries in the legend'' ([[Module:Yesno|yesno]])                       [optional, defaults to: yes]
{{!}}reclbl     = ''alternate label for the 2nd cases classification''                          [optional, defaults to: Recoveries]
{{!}}altlbl1    = ''alternate label for the 3rd cases classification'' (hide)                   [optional, defaults to: Active cases]
{{!}}altlbl2    = ''alternate label for the 4th cases classification''                          [optional]
{{!}}altlbl3    = ''alternate label for the 5th cases classification''                          [optional]

{{!}}collapsible= ''whether rows are collapsible (forced ''no'' if days span <= duration)'' (yesno) [optional, defaults to: 'auto']
{{!}}duration   = ''span of last days to initially display to control default chart height''    [optional, defaults to: 15]
{{!}}nooverlap  = ''whether to prevent the last month's toggle from overlapping, in days,''     [optional, defaults to: no; see info below]
              ''with the "Last XX days" toggle'' (yesno)
{{!}}right1     = ''heading of the 1st data column''                                            [optional, defaults to: # of cases]
{{!}}right1data = ''cases classification of the 1st column for auto filling'' (1-5{{!}}alttot1-2)   [optional, defaults to: 3, if right1 is "# of cases"]
{{!}}changetype1= ''calculate percent change (%), absolute change (#),''                        [optional, defaults to: percent]
              ''or weekly incidence (w)'' (p{{!}}a{{!}}w)
{{!}}right2     = ''heading of the 2nd data column''                                            [optional]
{{!}}right2data = ''cases classification of the 2nd column for auto filling'' (1-5{{!}}alttot1-2)   [optional, defaults to: 1, if right2 is "# of deaths"]
{{!}}changetype2= ''calculate percent change (%), absolute change (#), onlypercent (o),''       [optional, defaults to: percent]
               ''or weekly incidence (w)'' (p{{!}}a{{!}}o{{!}}w)
{{!}}changetype = ''applies to both 1st and 2nd change columns''                                [optional]
{{!}}population = ''population count, required for weekly incidence, otherwise no effect''      [optional, if changetype w is set without population, it will default to percent]

{{!}}datapage   = ''tabular data page from Commons to scrape cases data from''                  [optional; see its [[Template talk:Medical cases chart#Tabular data from Commons|talk section]] and [[Module:Medical cases chart/data|module]]]
{{!}}data       = ''data lines for each valid date or interval''                                [suggested; see [[#Data|Data's syntax]]]

{{!}}footer    = ''footer of the chart''                                                   [suggested]
{{))}}
}}

It may be desirable to make a specific outbreak chart have different widths depending on the page it is displayed. The <code>barwidth</code> parameter can be used to achieve this. For example, {{para|barwidth|<nowiki>{{{barwidth|wide}}}</nowiki>}} will display the chart wide in the template page itself, but will allow different widths when the outbreak template is transcluded with this parameter in article pages.

<code>numwidth</code> is a sequence of the initials of '''n'''one, '''t'''hin, '''m'''edium, '''w'''ide, e'''x'''tra wide and '''d'''efault, and it determines the maximum width of each number in the data columns. Therefore, one should be chosen that minimizes the total width, but which doesn't make the numbers break/wrap on mobile view. Using 2 or 4 characters allocates one or two data columns, respectively. For example, {{para|numwidth|mw}} sets the right1 value column to medium and the right1 change column to wide. {{para|numwidth|mwnt}} sets the right1 value column to medium, the right1 change column to wide, the right2 value column to none, and the right2 change column to thin.

{| class="wikitable" style="margin-left:auto; margin-right:auto; text-align:center"
|+ Optimal numwidth ranges
|-
! numwidth !! Number !! Percent change{{efn|name=n1}} !! Absolute change{{efn|name=n1}}
|-
| t ||          1−9,999       ||       ''none''              ||       ±1−±99
|-
| m ||     10,000−99,999      ||    ±X.X% or ±1%−±99%        ||     ±100−±999
|-
| w ||    100,000−9,999,999   ||   ±0.XX% or +100%−±999%     ||   ±1,000−±99,999
|-
| x || 10,000,000−999,999,999 || ±0.00XX% or ±1,000−±99,999% || ±100,000−±999,999
|}
{{notelist|refs=
{{efn|name=n1|Brackets also fit as they are automatically generated}}
}}

The {{tl|navbar}} links are constructed like this: "<code>outbreak</code> data/<code>[</code><code>[</code><code>location3</code>/<code>]</code><code>location2</code>/<code>]</code><code>*location</code> medical cases chart". <code>outbreak</code> may be more descriptive than <code>disease</code> to avoid page name collisions. So, for example, COVID-19 charts have {{para|outbreak|COVID-19 pandemic}}. <code>location</code> has "the " internally removed and is capitalized to become <code>*location</code>.

By default, the "Last X days" button toggles days which intersect with those of the last months. This happens regardless of the state (activated or not) of the month buttons. In fact, due to limitations of [https://doc.wikimedia.org/mediawiki-core/master/js/source/jquery.makeCollapsible.html custom collapsing], toggles are stateless (a workaround is used to simulate two 'states'). All in all, this can lead to situations where clicking one button causes unintuitive toggling like creating date gaps. <code>nooverlap</code> works around this issue by forcing the buttons of the last months to not overlap with the "Last X days" button. The result is usually a partial last month button, "Mon XX-XX", where XX are the first and last days of the month that the button affects. Extra info in the [[Template talk:Medical cases chart#"Last 15 days" bug?|main bug discussion]].

To display absolute change in the first column and percent change in the second column, set the following (AA represents any two allowed characters, # represents the classification number being shown, which should be the same for <code>right1data</code> and <code>right2data</code>):

 |numwidth=AAnw
 |right1data=#
 |changetype1=a
 |right2data=#
 |changetype2=o

=== Data ===

The <code>data</code> parameter should be populated by a sequence of lines containing a different set of parameters separated by semicolons, <code>;</code>.

{{pre|1=
{{!}}data=
{{cslist|semi=y|''date''|''deaths''|''2nd classification (recoveries)''|''3rd classification (total or altlbl1)''|''4th classification #''|''5th classification #''|''1st column #''|''1st column change''|''2nd column #''|''2nd column change''|''other parameters{{=}}values''}}
{{cslist|semi=y|''date''|''deaths''|''2nd classification (recoveries)''|''3rd classification (total or altlbl1)''|''4th classification #''|''5th classification #''|''1st column #''|''1st column change''|''2nd column #''|''2nd column change''|''other parameters{{=}}values''}}
...
}}

All values are optional, and empty values can be represented by sequential semicolons (e.g. <code>;;</code>). Omitting the date will treat the row as a date interval, unless the date can be automatically interpolated (for 1 day intervals). This is mostly done when no new cases are reported. Omitting a classification value makes a 0 width stacked bar and omitting all values or the line itself is recommended to depict dates where no data is reported.

The expression for total in the 3rd cases classification has deaths and recoveries automatically subtracted from it. If a manual calculation of the number in that classification (generally active cases) is wanted, use <code>alttot1</code>. The same applies to the expression for total in the 5th cases classification and <code>alttot2</code>.

The <code>''1st column #''</code>, <code>''1st column change''</code>, <code>''2nd column #''</code>, and <code>''2nd column change''</code> values can be automatically calculated if omitted. The 1st column values will be automatically calculated if <code>right1</code> is omitted or {{para|right1|# of cases}}, and the 2nd column values will be automatically calculated if {{para|right2|# of deaths}}. If <code>right1</code> or <code>right2</code> are set to other values, the columns can still be automatically calculated by setting <code>right1data</code> and <code>right2data</code> to the classification number wanted for display in columns 1 and 2, respectively (e.g. <code>1</code> for deaths, <code>2</code> for recoveries, <code>3</code> for total, etc.).  The changes in the first and second columns are automatically wrapped in parentheses.

The <code>''other parameters=values''</code> can be any number of the parameters below and their values, separated by semicolons. See the examples.

 alttot1    = ''alternate expression for active cases (3rd cases classification)''
 alttot2    = ''alternate expression for number in the 5th cases classification''
 firstright1= ''whether a change in the first column is not applicable (n.a.)'' (yesno)
 firstright2= ''whether a change in the second column is not applicable (n.a.)'' (yesno)
 enddate    = ''end date of interval if automatic one causes incorrect toggling behavior [required if chart ends with interval]''
 note0      = ''note text post-fixed to the date, that should create a minimum space consuming object, like a note link, to avoid wrapping''
 note1      = ''like note0, only post-fixed to column 1''
 note2      = ''like note1, only post-fixed to column 2''

== Examples ==

<syntaxhighlight lang="wikitext">
{{#invoke:Medical cases chart|chart
|float=center
|numwidth=mw

|disease=Green Flu
|location=Savannah|location2=Georgia|location3=United States
|outbreak=2009 Green Flu outbreak

|recoveries=n

|data=
2009-04-13;;;42;;;42;firstright1=y
2009-04-14;;;356;;;356;+748%
2009-04-15;;;1503;;;1,503;+322%
2009-04-16;57;;5915;;;5,915;+294%
2009-04-17;2000;;9500;;;~9,500;+60.6%
}}
</syntaxhighlight>
{{#invoke:Medical cases chart|chart
|float=center
|numwidth=mw

|disease=Green Flu
|location=Savannah|location2=Georgia|location3=United States
|outbreak=2009 Green Flu outbreak

|recoveries=n

|data=
2009-04-13;;;42;;;42;firstright1=y
2009-04-14;;;356;;;356;+748%
2009-04-15;;;1503;;;1,503;+322%
2009-04-16;57;;5915;;;5,915;+294%
2009-04-17;2000;;9500;;;~9,500;+60.6%
}}{{clear}}

<syntaxhighlight lang="wikitext">
{{#invoke:Medical cases chart|chart
|barwidth=wide
|numwidth=mwwd
|rowheight=1.8

|pretitle=Approximate
|disease=Spanish Flu
|location=the World
|posttitle=(excluding Oceania)
|outbreak=1918-20 Spanish Flu pandemic

|altlbl1=Active confirmed
|altlbl2=Suspected
|altlbl3=Estimated

|collapsible=n

|right1=Confirmed cases
|right2=Including suspected and estimated cases

|data=
1918-03-10;2060-300;3000-800;6000;;;6000;firstright1=y
1918-07;12600;20000;40000;12000;;alttot2=(34000-15000-8700+40);40000;+500%;10500;firstright2=y
;12600;20000;40000;12000;;alttot2=(34000-15000-8700+40);40000;;10500
1919;100000;250000;;;1000000;;;1mi;+500k
}}
</syntaxhighlight>
{{#invoke:Medical cases chart|chart
|barwidth=wide
|numwidth=mwwd
|rowheight=1.8

|pretitle=Approximate
|disease=Spanish Flu
|location=the World
|posttitle=(excluding Oceania)
|outbreak=1918-20 Spanish Flu pandemic

|altlbl1=Active confirmed
|altlbl2=Suspected
|altlbl3=Estimated

|collapsible=n

|right1=Confirmed cases
|right2=Including suspected and estimated cases

|data=
1918-03-10;2060-300;3000-800;6000;;;6000;firstright1=y
1918-07;12600;20000;40000;12000;;alttot2=(34000-15000-8700+40);40000;+500%;10500;firstright2=y
;12600;20000;40000;12000;;alttot2=(34000-15000-8700+40);40000;;10500
1919;100000;250000;;;1000000;;;1mi;+500k
}}{{clear}}

<syntaxhighlight lang="wikitext">
{{#invoke:Medical cases chart|chart
|numwidth=tttt

|disease=Ebola
|location=Guinea-Bissau
|outbreak=2014 EVD epidemic

|altlbl1=hide
|altlbl2=Moderate cases
|altlbl3=Severe cases (hospitalized)

|duration=5
|nooverlap=y

|right1=# of severe cases
|right1data=alttot2
|right2=# of deaths
|changetype=a

|data=
2014-01-01;;;;;;alttot2=1;;+1
2014-01-15;1;;;;;alttot2=1;;=;;+1
<!-- no data reported -->
2014-01-20;2;;;1;;alttot2=1;;=;;+1
<!-- no data reported -->note0={{efn|On Jan 21st, there was a national blackout that forced the data to be reported on the next day.}}
2014-01-22;2;;;2;;alttot2=2;;+1;;=
;2;;;2;;alttot2=2
;2;1;;1;;alttot2=2
2014-02-05;3;1;;1;;alttot2=1
;3;2;;;;alttot2=1;enddate=2014-03-01
;3;2;;1;;alttot2=1
2014-03-30;3;4;;;;alttot2=0;note1={{efn|On Mar 30th, new cases were reported just before the press conference, thus they weren't included in the official count.}}
2014-03-31;3;4;;2;;alttot2=1;;+1
2014-04-01;3;5;;4;;alttot2=2
2014-04-02;5;6;;5;;alttot2=3;note2={{efn|The death of a foreigner at a border crossing medical tent is under dispute if it should be included in Guinea-Bissau's count.}}
;5;8;;3;;alttot2=3;enddate=2014-04-04

|footer={{notelist}}
}}
</syntaxhighlight>
{{#invoke:Medical cases chart|chart
|numwidth=tttt

|disease=Ebola
|location=Guinea-Bissau
|outbreak=2014 EVD epidemic

|altlbl1=hide
|altlbl2=Moderate cases
|altlbl3=Severe cases (hospitalized)

|duration=5
|nooverlap=y

|right1=# of severe cases
|right1data=alttot2
|right2=# of deaths
|changetype=a

|data=
2014-01-01;;;;;;alttot2=1;;+1
2014-01-15;1;;;;;alttot2=1;;=;;+1
<!-- no data reported -->
2014-01-20;2;;;1;;alttot2=1;;=;;+1
<!-- no data reported -->note0={{efn|On Jan 21st, there was a national blackout that forced the data to be reported on the next day.}}
2014-01-22;2;;;2;;alttot2=2;;+1;;=
;2;;;2;;alttot2=2
;2;1;;1;;alttot2=2
2014-02-05;3;1;;1;;alttot2=1
;3;2;;;;alttot2=1;enddate=2014-03-01
;3;2;;1;;alttot2=1
2014-03-30;3;4;;;;alttot2=0;note1={{efn|On Mar 30th, new cases were reported just before the press conference, thus they weren't included in the official count.}}
2014-03-31;3;4;;2;;alttot2=1;;+1
2014-04-01;3;5;;4;;alttot2=2
2014-04-02;5;6;;5;;alttot2=3;note2={{efn|The death of a foreigner at a border crossing medical tent is under dispute if it should be included in Guinea-Bissau's count.}}
;5;8;;3;;alttot2=3;enddate=2014-04-04

|footer={{notelist}}
}}{{clear}}

=== Applied example ===

{{tl|COVID-19 pandemic data/Mainland China medical cases chart}}
<syntaxhighlight lang="wikitext">
{{#invoke:Medical cases chart|chart
|numwidth=mmmw

|disease=COVID-19
|location=Mainland China
|outbreak=COVID-19 pandemic

|altlbl1=Tested
|altlbl2=Clinically diagnosed (C.D.)
|altlbl3=Tested or C.D.

|right1=Number of cases<br />(excluding C.D.)
|right2=Number of cases<br />(including C.D.)

|data=
...

|footer=
<div class="center" style="width:90%; margin-left:auto; margin-right:auto;"><small>...</small></div>
...
}}
</syntaxhighlight><noinclude>
{{COVID-19 pandemic data/Mainland China medical cases chart}}{{clear}}
{{Reflist-talk}}</noinclude><includeonly>

== TemplateData ==

<templatedata>{
	"description": "Produces charts based on {{Bar box}} for outbreak, epidemic and pandemic medical cases.",
	"format": "{{_\n|_=_\n}}",
	"params": {
		"barwidth": {
			"label": "Bar width",
			"description": "width of the stacked bars area (thin|medium|wide|auto)",
			"type": "string",
			"default": "medium"
		},
		"numwidth": {
			"label": "Number width",
			"description": "maximum width of the numbers in the right columns (AA or AAAA)←(n|t|m|w|x|d)",
			"type": "string",
			"default": "mm",
			"example": "mwnt",
			"suggested": true
		},
		"float": {
			"label": "Float",
			"description": "side of the page where the chart will be located (left|center|right|none)",
			"type": "string",
			"default": "right"
		},
		"pretitle": {
			"label": "Pretitle",
			"description": "text at the beginning of the title",
			"type": "string"
		},
		"disease": {
			"label": "Disease",
			"description": "name of the disease",
			"type": "string",
			"example": "COVID-19",
			"required": true
		},
		"location": {
			"label": "Location",
			"description": "location of the outbreak the chart is showing",
			"type": "string",
			"example": "the United States",
			"required": true
		},
		"location2": {
			"label": "Location 2",
			"description": "broader location such as state/province or country",
			"type": "string",
			"example": "Maharashtra"
		},
		"location3": {
			"label": "Location 3",
			"description": "broadest location such as country",
			"type": "string",
			"example": "India"
		},
		"posttitle": {
			"label": "Post-title",
			"description": "text at the end of the title",
			"type": "string",
			"example": "(including Greenland and the Faroe Islands)"
		},
		"outbreak": {
			"label": "Outbreak",
			"description": "name of the main outbreak for the links of the {{navbar}}",
			"type": "string",
			"example": "COVID-19 pandemic",
			"required": true
		},
		"recoveries": {
			"label": "Recoveries",
			"description": "whether to display recoveries in the legend (yesno)",
			"default": "yes",
			"autovalue": "n"
		},
		"reclbl": {
			"label": "Recoveries label",
			"description": "alternate label for the recoveries classification",
			"type": "string",
			"default": "Recoveries"
		},
		"altlbl1": {
			"label": "Alternate label 1",
			"description": "alternate label for the third cases classification (hide)",
			"type": "string",
			"default": "Active cases",
			"example": "hide"
		},
		"altlbl2": {
			"label": "Alternate label 2",
			"description": "alternate label for the fourth cases classification",
			"type": "string",
			"example": "Clinically diagnosed (C.D.)"
		},
		"altlbl3": {
			"label": "Alternate label 3",
			"description": "alternate label for the fifth cases classification",
			"type": "string",
			"example": "Tested or C.D."
		},
		"right1": {
			"label": "Right 1",
			"description": "heading of the first data column",
			"type": "string",
			"default": "# of cases"
		},
		"right2": {
			"label": "Right 2",
			"description": "heading of the second data column",
			"type": "string",
			"autovalue": "# of deaths"
		},
		"data": {
			"label": "Data",
			"description": "data lines for each valid date or interval (see Data's syntax)",
			"type": "content",
			"example": "2009-04-13;;;42;;;42;firstright1=y\n2009-04-14;;;356;;;356;+748%\n2009-04-15;;;1503;;;1,503;+322%",
			"suggested": true
		},
		"collapsible": {
			"label": "Collapsible",
			"description": "whether the rows are collapsible (forced \"no\" if the days span <= Duration) (yesno)",
			"default": "internally determined",
			"autovalue": "n"
		},
		"caption": {
			"label": "Caption",
			"description": "caption under the chart",
			"type": "content",
			"example": "'''Sources:'''\n...",
			"suggested": true
		},
		"rowheight": {
			"label": "Row height",
			"description": "height of each bar in multiples of the text height",
			"type": "number",
			"default": "1.6"
		},
		"duration": {
			"label": "Duration",
			"description": "span of last days to initially display to control the default chart height",
			"type": "number",
			"default": "15"
		},
		"nooverlap": {
			"label": "No overlap",
			"description": "whether to prevent the last month's toggle from overlapping, in days, with the \"Last XX days\" toggle (yesno)",
			"default": "no",
			"autovalue": "y"
		},
		"right1data": {
			"label": "Right 1 data",
			"description": "cases classification of the first column for auto filling (1-5|alttot1-2)",
			"default": "3 (if Right 1 is \"# of cases\")",
			"example": "alttot1"
		},
		"changetype1": {
			"label": "Change type 1",
			"description": "whether to calculate percent change (%) or absolute change (#) (p|a)",
			"type": "string",
			"default": "percent",
			"autovalue": "a"
		},
		"right2data": {
			"label": "Right 2 data",
			"description": "cases classification of the second column for auto filling (1-5|alttot1-2)",
			"default": "1 (if Right 2 is \"# of deaths\")",
			"example": "alttot2"
		},
		"changetype2": {
			"label": "Change type 2",
			"description": "whether to calculate percent change (%), absolute change (#) or onlypercent (p|a|o)",
			"type": "string",
			"default": "percent"
		},
		"changetype": {
			"label": "Change type",
			"description": "applies to both first and second change columns",
			"type": "string",
			"autovalue": "a"
		},
		"datapage": {
			"label": "Data page",
			"description": "tabular data page from Commons to scrape cases data from",
			"example": "COVID-19 cases in Santa Clara County, California.tab"
		}
	},
	"paramOrder": [
		"float",
		"barwidth",
		"numwidth",
		"rowheight",
		"pretitle",
		"disease",
		"location",
		"location2",
		"location3",
		"posttitle",
		"outbreak",
		"recoveries",
		"reclbl",
		"altlbl1",
		"altlbl2",
		"altlbl3",
		"collapsible",
		"duration",
		"nooverlap",
		"right1",
		"right1data",
		"changetype1",
		"right2",
		"right2data",
		"changetype2",
		"changetype",
		"datapage",
		"data",
		"caption"
	]
}</templatedata>

{{Sandbox other||
[[Category:Infectious disease templates]]
[[Category:Bar chart templates]]
[[Category:Graph, chart and plot templates]]
}}</includeonly>