Template:Medical cases chart/sandbox

__EXPECTUNUSEDTEMPLATE__This is the template sandbox page for Template:Medical cases chart (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template uses Lua:

Module:Medical cases chart (sandbox)

Description

This template should be used for all outbreak, epidemic and pandemic medical cases charts based on {{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 transcluded in other templates, NOT in article pages. Suggest features in the talk page or code them if they're neither controversial nor incompatibility prone.

Usage

{{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 {{navbar}}                 [see info below]

|recoveries = whether to display recoveries in the legend (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 talk section and module]
|data       = data lines for each valid date or interval                                [suggested; see 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 barwidth parameter can be used to achieve this. For example, |barwidth={{{barwidth|wide}}} 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.

numwidth is a sequence of the initials of none, thin, medium, wide, extra wide and default, 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, |numwidth=mw sets the right1 value column to medium and the right1 change column to wide. |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.

Optimal numwidth ranges
numwidth	Number	Percent change^[a]	Absolute change^[a]
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

^ ^1.0 ^1.1 Brackets also fit as they are automatically generated

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

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 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. nooverlap 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 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 right1data and right2data):

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

Data

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

|data=
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
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. ;;). 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 alttot1. The same applies to the expression for total in the 5th cases classification and alttot2.

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

The other parameters=values 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"> table </syntaxhighlight>

table

<syntaxhighlight lang="wikitext"> table </syntaxhighlight>

table

<syntaxhighlight lang="wikitext"> table </syntaxhighlight>

table

Applied example

{{COVID-19 pandemic data/Mainland China medical cases chart}} <syntaxhighlight lang="wikitext"> table </syntaxhighlight>

TemplateData

Produces charts based on {{Bar box}} for outbreak, epidemic and pandemic medical cases.

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

The above documentation is transcluded from Template:Medical cases chart/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

[n1-1] 1.0 ^1.1 Brackets also fit as they are automatically generated

[a]