View source for Module:Medical cases data/doc

{{Module rating|alpha}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
This module inserts charts and maps of medical cases related to a pandemic, broken down by subregions.

== <code>caseTable</code> ==
Inserts a table of cases and deaths by region.

Usage: {{mlx|{{BASEPAGENAME}}|''caseTable''|config{{=}}''Configuration''}}

{{#invoke:Demo|module|demo_module={{BASEPAGENAME}}|demo_module_func=caseTable|config=San Francisco Bay Area}}
{{-}}

== <code>map</code> ==
Inserts an interactive map of cases and deaths by region.

Usage: {{mlx|{{BASEPAGENAME}}|''map''|config{{=}}''Configuration''|frameWidth{{=}}''Frame width in pixels''|frameHeight{{=}}''Frame height in pixels''|caption{{=}}''Caption as wikitext''}}

{{#invoke:Demo|module|demo_module={{BASEPAGENAME}}|demo_module_func=map|config=San Francisco Bay Area|frameHeight=300}}
{{-}}

== Configuration ==
[https://w.wiki/Z7E Run this Wikidata Query Service query] to obtain a list of localized outbreaks to add to the <code>regions</code> property in the table.

<syntaxhighlight lang="Lua">
return {
	caption = "Cases by county", -- Table or map caption as wikitext
	outbreakItem = "Q94050008", -- QID of the Wikidata item representing the 
	regionTerm = "Counties", -- Term for each region, used as the first column's header
	regionNamePattern = "(.+) County", -- Naming pattern for regions, applied to each region's item's label to display a short name in first column; see [[mw:Extension:Scribunto/Lua reference manual#Patterns]]
	populationDate = "2020-01-01", -- Date of the population figures used to calculate per-capita infection rates
	regions = {
		-- Add a table for each region's outbreak
		{
			-- QID of the outbreak
			entity = "Q94259368",
			-- If there is tabular data for the outbreak, specify any column names that differ from the defaults
			columns = {cases = "AC_CumulCases", deaths = "AC_CumulDeaths"},
			-- Optional footnote for the region as wikitext
			note = "Including cases in the City of Berkeley, which are reported by the Berkeley Public Health Division.",
		},
	},
	columnNotes = {
		cases = "Cumulative cases reported by each county's health department.", -- (Optional) Footnote for the "Cases" column as wikitext
		recoveries = "Counties differ in what they consider to be a recovery.", -- (Optional) Footnote for the "Recoveries" column as wikitext
		deaths = "Includes suspected cases.", -- (Optional) Footnote for the "Deaths" column as wikitext
	}
}
</syntaxhighlight>

== Available configurations ==
{{Special:PrefixIndex/Module:Medical cases data/}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->

}}</includeonly>