R6 Class Representing a IncidenceAnalysis

The IncidenceAnalysis class, encapsulating the targets, outcomes and tars.

Details

The targets, outcomes and tars fields are referencing IDs of the targetDef, outcomeDef and tarDefs R6 classes.

Note, when serializing with a library such as jsonlite, first call toList() on the R6 class before calling jsonlite::toJSON().

Active bindings

targets

A vector of target IDs from target definitions. Must be a vector.

outcomes

A vector of outcome IDs from outcome definitions. Must be a vector.

tars

A vector of TAR IDs from time-at-risk definitions. Must be a vector.

Methods

Public methods

• IncidenceAnalysis$new()

• IncidenceAnalysis$toList()

• IncidenceAnalysis$asJSON()

• IncidenceAnalysis$clone()

---

Method new()

creates a new instance, using the provided data param if provided.

Usage

IncidenceAnalysis$new(data = list())

Arguments

data

the data (as a json string or list) to initialize with

---

Method toList()

returns the R6 class elements as a list for use in jsonlite::toJSON()

Usage

IncidenceAnalysis$toList()

---

Method asJSON()

returns the JSON string for this R6 class

Usage

IncidenceAnalysis$asJSON()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

IncidenceAnalysis$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.