CorrelationParameters: Class: Correlation parameters Describes an event in the...

In pahanc/malariasimulation_Ace_params: An individual based model for malaria

Class: Correlation parameters Describes an event in the simulation

Description

Class: Correlation parameters Describes an event in the simulation

Class: Correlation parameters Describes an event in the simulation

Methods

Public methods

• CorrelationParameters$new()

• CorrelationParameters$inter_round_rho()

• CorrelationParameters$inter_intervention_rho()

• CorrelationParameters$sigma()

• CorrelationParameters$mvnorm()

• CorrelationParameters$clone()

---

Method new()

initialise correlation parameters

Usage

CorrelationParameters$new(parameters)

Arguments

parameters

model parameters

---

Method inter_round_rho()

Add rho between rounds

Usage

CorrelationParameters$inter_round_rho(int, rho)

Arguments

int

string representing the intervention to update

rho

value between 0 and 1 representing the correlation between rounds of the intervention

---

Method inter_intervention_rho()

Add rho between interventions

Usage

CorrelationParameters$inter_intervention_rho(int_1, int_2, rho)

Arguments

int_1

string representing the first intervention

int_2

string representing the second intervention (intechangable with int_1)

rho

value between -1 and 1 representing the correlation between rounds of the intervention

---

Method sigma()

Standard deviation of each intervention between rounds

Usage

CorrelationParameters$sigma()

---

Method mvnorm()

multivariate norm draws for these parameters

Usage

CorrelationParameters$mvnorm()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

CorrelationParameters$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

pahanc/malariasimulation_Ace_params documentation built on March 12, 2024, 2:21 a.m.