SyndromeProvider: Syndrome provider base class

In cturbelin/ifnBase: InfluenzaNet Data Analysis Base

Syndrome provider base class

Description

Syndrome provider base class

Syndrome provider base class

Details

Define interface to build a SyndromeProvider

This class compute "syndrome" definition from weekly & intake data A syndrome will be computed as a logical value attributed for each weekly survey, with value TRUE if the survey comply with the given syndrome definition

A syndrome provider can compute several syndromes, each one applying for a definition

compute() should return a data.frame() with one logical column for each computed syndrome definition (use names carefully to avoid names collisions, avoid using influenzanet base syndrome names : ili, cold, allergy, gastro )

Methods

Public methods

• SyndromeProvider$compute()

• SyndromeProvider$compute_age()

• SyndromeProvider$is_sudden()

• SyndromeProvider$syndromes()

• SyndromeProvider$clone()

---

Method compute()

Compute syndrome

Usage

SyndromeProvider$compute(weekly, intake)

Arguments

weekly

weekly data

intake

intake data

Returns

data.frame() with id column from weekly and extra column for each syndrome

---

Method compute_age()

Compute age for each weekly using intake

Usage

SyndromeProvider$compute_age(weekly, intake)

Arguments

weekly

weekly data

intake

intake data Common function, compute sudden symptomes using both variables

---

Method is_sudden()

Usage

SyndromeProvider$is_sudden(r)

Arguments

r

weekly data

---

Method syndromes()

Get available syndromes names

Usage

SyndromeProvider$syndromes()

Returns

character()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SyndromeProvider$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

cturbelin/ifnBase documentation built on Aug. 26, 2024, 12:54 p.m.