README.md

In epidesc: Calculation of Epidemiological Descriptors

epidesc

Overview

The R package epidesc provides the tools to easily compute a series of epidemiological indicators to characterise different transmission profiles of infectious diseases. The work is based on the publication 'How heterogeneous is the dengue transmission profile in Brazil? A study in six Brazilian states' (https://doi.org/10.1371/journal.pntd.0010746) published in PLoS Neglected Tropical Diseases by Iasmim Ferreira de Almeida, Raquel Martins Lana and Cláudia Torres Codeço in 2022.

The epidesc pipeline to compute the indicators is as follows:

• Formatting dates in epiyearweek format.
• Choosing descriptors and its parameters from the catalogue.
• Compute descriptors.

Before computing the descriptors, ensure the data meet the following requirements:

• The input data has to be a data.frame with the cases and spatiotemporal identifiers.
• The data needs to be weekly with dates in Date format.
• If an incidence descriptor is required, the population at risk also needs to be provided.

To find out more, please see the package vignette by typing vignette("epidesc").

Included descriptors

The current version of the package includes the following descriptors:

library("epidesc")
knitr::kable(desc_list())

| class | fun | description | param1 | param2 | |:--------------|:--------------|:--------------|:--------------|:--------------| | Peak | Ap | Maximum cases peak - amplitude | | | | Peak | Tp | Week where the maximum peak occurred - time | | | | Period with cases | Cnf | Frequency of periods of consecutive 'n' weeks or longer with at least 'x' cases | n | x | | Period with cases | Cmax | Maximum duration in consecutive weeks with at least 'x' cases | x | | | Period with cases | Cmed | Median duration in consecutive weeks with at least 'x' cases | x | | | Period with cases | Isof | Number of weeks with isolated cases | | | | Period with cases | p | Proportion of weeks with at least 'x' cases | x | | | Period without cases | Cwf | Frequency of periods of consecutive weeks with at least 'n' weeks without cases. | n | | | Period without cases | Cwmax | Maximum duration in consecutive weeks without cases | | | | Period without cases | Cwmed | Median duration in consecutive weeks without cases | | | | Incidence | Inc | Annual incidence rate per 'p' population | p | |

Contributions

If you would like to contribute a new descriptor to epidesc, please open an issue with your idea or get in touch with Raquel Martins Lana (raquel.lana\@bsc.es, raquelmlana\@gmail.com) or Carles Milà (carles.milagarcia\@bsc.es) to discuss its inclusion.

Installation

epidesc is available on CRAN and can be installed as follows:

install.packages("epidesc")

You can install the development version of epidesc as follows:

pak::pak("https://github.com/BSC-ES/epidesc.git")

Package authors

Raquel Martins Lana, PhD \ Barcelona Supercomputing Center (BSC)

Carles Milà, PhD \ Barcelona Supercomputing Center (BSC)

Iasmin Ferreira de Almeida, PhD \ Getulio Vargas Foundation (FGV)

Claudia Torres Codeço, PhD \ Oswaldo Cruz Foundation (Fiocruz)

Daniela Lührsen, MSc \ Barcelona Supercomputing Center (BSC)

Diego Ricardo Xavier Silva, PhD \ Oswaldo Cruz Foundation (Fiocruz)

Christovam Barcellos, PhD \ Oswaldo Cruz Foundation (Fiocruz)

Rachel Lowe, PhD \ Barcelona Supercomputing Center (BSC)\ Catalan Institution for Research & Advanced Studies (ICREA)

Acknowledgments

Raquel M. Lana is funded by the European Union (Marie Sklodowska-Curie Actions, grant agreement 101109642).

Diego Ricardo Xavier and Raquel M. Lana acknowledge the project CNPq 445194/2024-3 - Development of Indicators for the Detection and Characterization of Anomalies in Climate-Sensitive Tropical Diseases in Brazil.

Rachel Lowe, Claudia T. Codeço and Christovam Barcellos acknowledge the Wellcome Trust HARMONIZE 224694/Z/21/Z.

Rachel Lowe and Claudia T. Codeço acknowledge the Wellcome Trust IDExtremes 226069/Z/22/Z.

Iasmim Almeida acknowledges the Wellcome Trust (Mosqlimate 226088/Z/22/Z) and the Coordenação de Aperfeiçoamento de Pessoal de Nível Superior (CAPES, Finance Code 001).

Daniela Lührsen was supported by the Barcelona Supercomputing Center AI4Science Fellowship programme funded by the Recovery and Resilience Mechanism-Next Generation as part of the Spanish Ministry's Recovery, Transformation and Resilience Plan.

Christovam Barcellos acknowledges financial support from CNPq (process 444665/2023-4) and the Pasteur Network (Climate–Health Observatory Accelerator Project).

epidesc documentation built on Aug. 8, 2026, 1:06 a.m.