attrdl

A function to calculate attributable numbers and fractions derived from
(c) Antonio Gasparrini 2015-2017.

internal

Tools for producing climate-health indicators and supporting
official statistics from health and climate data. Implements analytical
workflows for temperature-related mortality, wildfire smoke exposure,
air pollution, suicides related to extreme heat, malaria, and
diarrhoeal disease outcomes, with utilities for descriptive statistics, model
validation, attributable fraction and attributable number estimation,
relative risk estimation, minimum mortality temperature estimation,
and plotting for reporting. These six indicators are endorsed by
the United Nations Statistical Commission for inclusion in the
Global Set of Environment and Climate Change Statistics.
Implemented methods include distributed lag non-linear models (DLNM),
quasi-Poisson time-series regression, case-crossover analysis,
Bayesian spatio-temporal models using the Integrated Nested Laplace
Approximation ('INLA'), and multivariate meta-analysis for
sub-national estimates. The package is based on methods developed
in the Standards for Official Statistics on Climate-Health
Interactions (SOSCHI) project
<https://climate-health.officialstatistics.org>. For methodologies,
see Watkins et al. (2025) <doi:10.5281/zenodo.14865904>,
Brown et al. (2024) <doi:10.5281/zenodo.14052183>,
Pearce et al. (2024) <doi:10.5281/zenodo.14050224>,
Byukusenge et al. (2025) <doi:10.5281/zenodo.15585042>,
Dzakpa et al. (2025) <doi:10.5281/zenodo.14881886>, and
Dzakpa et al. (2025) <doi:10.5281/zenodo.14871506>.

Kenechi Omeke

climatehealth

Statistical Tools for Modelling Climate-Health Impacts

Charlie Browning

Etse Yawo Dzakpa

Gladin Jose

Matt Pearce

Ellie Watkins

Claire Hunt

Beatrice Byukusenge

Cassien Habyarimana

Venuste Nyagahakwa

Felix Scarbrough

Treesa Shaji

Bonnie Lewis

Maquines Odhiambo Sewe

Vijendra Ingole

Sean Lovell

Antony Brown

Euan Soutter

Gillian Flower

David Furley

Joe Panes

Charlotte Romaniuk

Milly Powell

Wellcome 

Office for National Statistics 

attrdl function

<dl><dt>x</dt>
<dd>AN EXPOSURE VECTOR OR (ONLY FOR dir="back") A MATRIX OF LAGGED EXPOSURES</dd>
<dt>basis</dt>
<dd>THE CROSS-BASIS COMPUTED FROM x</dd>
<dt>cases</dt>
<dd>THE CASES VECTOR OR (ONLY FOR dir="forw") THE MATRIX OF FUTURE CASES</dd>
<dt>model</dt>
<dd>THE FITTED MODEL</dd>
<dt>coef</dt>
<dd>COEF FOR basis IF model IS NOT PROVIDED</dd>
<dt>vcov</dt>
<dd>VCOV FOR basis IF model IS NOT PROVIDED</dd>
<dt>model.link</dt>
<dd>LINK FUNCTION IF model IS NOT PROVIDED</dd>
<dt>type</dt>
<dd>EITHER "an" OR "af" FOR ATTRIBUTABLE NUMBER OR FRACTION</dd>
<dt>dir</dt>
<dd>EITHER "back" OR "forw" FOR BACKWARD OR FORWARD PERSPECTIVES</dd>
<dt>tot</dt>
<dd>IF TRUE, THE TOTAL ATTRIBUTABLE RISK IS COMPUTED</dd>
<dt>cen</dt>
<dd>THE REFERENCE VALUE USED AS COUNTERFACTUAL SCENARIO</dd>
<dt>range</dt>
<dd>THE RANGE OF EXPOSURE. IF NULL, THE WHOLE RANGE IS USED</dd>
<dt>sim</dt>
<dd>IF SIMULATION SAMPLES SHOULD BE RETURNED. ONLY FOR tot=TRUE</dd>
<dt>nsim</dt>
<dd>NUMBER OF SIMULATION SAMPLES</dd></dl>

Arguments

FUNCTION FOR COMPUTING ATTRIBUTABLE MEASURES FROM DLNM — attrdl

<dl>

<dt>x</dt>
<dd>AN EXPOSURE VECTOR OR (ONLY FOR dir="back") A MATRIX OF LAGGED EXPOSURES</dd>


<dt>basis</dt>
<dd>THE CROSS-BASIS COMPUTED FROM x</dd>


<dt>cases</dt>
<dd>THE CASES VECTOR OR (ONLY FOR dir="forw") THE MATRIX OF FUTURE CASES</dd>


<dt>model</dt>
<dd>THE FITTED MODEL</dd>


<dt>coef</dt>
<dd>COEF FOR basis IF model IS NOT PROVIDED</dd>


<dt>vcov</dt>
<dd>VCOV FOR basis IF model IS NOT PROVIDED</dd>


<dt>model.link</dt>
<dd>LINK FUNCTION IF model IS NOT PROVIDED</dd>


<dt>type</dt>
<dd>EITHER "an" OR "af" FOR ATTRIBUTABLE NUMBER OR FRACTION</dd>


<dt>dir</dt>
<dd>EITHER "back" OR "forw" FOR BACKWARD OR FORWARD PERSPECTIVES</dd>


<dt>tot</dt>
<dd>IF TRUE, THE TOTAL ATTRIBUTABLE RISK IS COMPUTED</dd>


<dt>cen</dt>
<dd>THE REFERENCE VALUE USED AS COUNTERFACTUAL SCENARIO</dd>


<dt>range</dt>
<dd>THE RANGE OF EXPOSURE. IF NULL, THE WHOLE RANGE IS USED</dd>


<dt>sim</dt>
<dd>IF SIMULATION SAMPLES SHOULD BE RETURNED. ONLY FOR tot=TRUE</dd>


<dt>nsim</dt>
<dd>NUMBER OF SIMULATION SAMPLES</dd>

</dl>

FUNCTION FOR COMPUTING ATTRIBUTABLE MEASURES FROM DLNM

attrdl: FUNCTION FOR COMPUTING ATTRIBUTABLE MEASURES FROM DLNM

Description

Usage

Value

Arguments