Vaccine: R6Class Vaccine

In OpenABMCovid19: Agent-Based Model for Modelling the COVID-19

Description

Vaccine object has information about each new vaccine

Active bindings

c_vaccine

the C vaccine R pointer object (SWIG wrapped)

Methods

Public methods

• Vaccine$new()

• Vaccine$idx()

• Vaccine$n_strain()

• Vaccine$time_to_protect()

• Vaccine$vaccine_protection_period()

• Vaccine$full_efficacy()

• Vaccine$symptoms_efficacy()

• Vaccine$severe_efficacy()

---

Method new()

Usage

Vaccine$new(model, vaccine_id)

Arguments

model

R6 Model object

vaccine_id

The vaccine ID.

---

Method idx()

Wrapper for C API vaccine$idx().

Usage

Vaccine$idx()

Returns

the index of the vaccine

---

Method n_strain()

Wrapper for C API vaccine$n_strains().

Usage

Vaccine$n_strain()

Returns

the number of strains the vaccine has efficacy for

---

Method time_to_protect()

Wrapper for C API vaccine$time_to_protect().

Usage

Vaccine$time_to_protect()

Returns

the time_to_protect of the vaccine

---

Method vaccine_protection_period()

Wrapper for C API vaccine$vaccine_protection_period().

Usage

Vaccine$vaccine_protection_period()

Returns

the vaccine_protection_period of the vaccine

---

Method full_efficacy()

Wrapper for C API vaccine$full_efficacy().

Usage

Vaccine$full_efficacy()

Returns

the full_efficacy of vaccine by strain

---

Method symptoms_efficacy()

Wrapper for C API vaccine$symptoms_efficacy().

Usage

Vaccine$symptoms_efficacy()

Returns

the symptoms_efficacy of vaccine by strain

---

Method severe_efficacy()

Wrapper for C API vaccine$severe_efficacy().

Usage

Vaccine$severe_efficacy()

Returns

the severe_efficacy of vaccine by strain

Examples

# Add new vaccine
model = Model.new( params = list(n_total = 10000) )
vaccine = model$add_vaccine()

OpenABMCovid19 documentation built on July 20, 2021, 5:08 p.m.