DEMITONMethodGitHub

Research / Sources / Schemas and history

Schemas and history

Every record here is checked against a JSON Schema, and every schema carries a semantic version: MAJOR when a change can make an existing record invalid, MINOR when it only adds, PATCH for wording. CI refuses a change whose version bump is too small (METHOD.md Section 10). Below is each schema as it stands and every version it has been.

Source 1.0.0

sources/<slug>.md: where a figure came from, and how it was read · source.schema.json

16 fields at 1.0.0
FieldTypeRequiredAllowed values
titlestringyes
organisationstringyes
organisation_idstring
yearintegeryes
published_instring
urlstring
free_copy_urlstring
source_typeone ofyespeer-reviewed, working-paper, regulator, court, industry-body, research-institute, vendor, press
methodone ofyessurvey, records, official-statistics, model, case-study, legal-text, estimate, unknown
accessone ofyesprimary, secondary
read_viastring
read_onstringyes
locationstringyes
jurisdictionslist of stringyes
industrieslist of stringyes
industry_as_publishedstring

Versions

Finding 2.3.0

diseases/<disease>/<metric>.yaml and context/<metric>.yaml: one figure · finding.schema.json

41 fields at 2.3.0
FieldTypeRequiredAllowed values
labelstringyes
exposure_valuenumber or nullyes
exposure_unitone ofyesratio_of_contract, ratio_of_other, per_wet_day, per_incident, none
denominatorone ofbudget_at_decision, budget_at_announcement, construction_cost, amount_claimed, arbitration_cost, total_injury_cost, overrun_additional_cost, annual_capital_budget
currencystring
price_yearinteger
exposure_basisstringyes
exposure_kindone ofyescontractor_loss, derived_contractor_loss, money_at_stake, owner_side, societal, context
confidenceone ofyeshigh, moderate, low
exposure_rangeobject
exposure_range.lownumberyes
exposure_range.highnumberyes
exposure_range.kindone ofyesconfidence_interval, reported_min_max, scenario, across_studies
derivationone ofyesas_published, calculated
calculationstring
sourceslist of yes
consideredlist of records
considered[].sourceyes
considered[].reasonstringyes
sample_notestringyes
caveatstringyes
statusone ofyescurrent, disputed, withdrawn
dispute_urlstring
withdrawn_reasonstring
historylist of records
history[].exposure_valuenumber or null
history[].exposure_unitstring
history[].denominatorstring
history[].exposure_rangeobject
history[].exposure_kindstring
history[].confidencestring
history[].is_headlineboolean
history[].changed_onstringyes
history[].change_urlstring
history[].reasonstringyes
subtypestring
statisticone ofmean, median, pooled_ratio, total, single_case, modelled, none, unknown
sample_sizeobject
sample_size.nintegeryes
sample_size.unitone ofyesprojects, respondents, organisations, decisions, awards, contracts, cases, years, other
sample_size.notestring

Versions

Protection 1.0.0

protections/<disease>/<mechanism>.yaml: evidence that a protection matters · protection.schema.json

9 fields at 1.0.0
FieldTypeRequiredAllowed values
labelstringyes
claimstringyes
sourcesfinding: sourcesyes
consideredfinding: considered
confidenceone ofyeshigh, moderate, low
caveatstringyes
statusone ofyescurrent, disputed, withdrawn
dispute_urlstring
withdrawn_reasonstring

Versions