Skip to contents

R6 Class Representing a IncidenceDesign

Source: R/Classes.R
IncidenceDesign.Rd

This class encapsulates the other R6 Class elements that define an IncidenceDesign

Value

A IncidenceDesign R6 object that stores the full cohort incidence analysis design, including cohort definitions, target definitions, outcomes, time-at-risk definitions, analyses, subgroups, strata settings, and study window metadata used to generate SQL.

Details

The IncidenceDesign class encapsulates the following:

  • Cohort Definitions

  • Target Definitions

  • Outcome Definitions

  • Time At Risk Definitions

  • A List of Analyses

  • Concept Sets

  • Subgruops

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

Active bindings

cohortDefs

A list of cohort definitions. Must be a list of CohortDefinition

conceptSets

A list of concept set expressions. Currently unused.

targetDefs

A list of cohort references to be used as target cohorts. Must be a list of CohortReference

outcomeDefs

A list of outcome definitions. Must be a list of Outcome

timeAtRiskDefs

A list of time-at-risk definitions. Must be a list of TimeAtRisk

analysisList

A list of analyses, containing the T-O-TAR combinations to perform. Must be a list of IncidenceAnalysis

subgroups

A list of subgroups. Must be a list of CohortSubgroup

strataSettings

The strata settings for this design. Must be a class StrataSettings

studyWindow

a study window for this design. Must be a list of class DateRange

firstAtRisk

a boolean indicating to limit TAR to first per person.

firstPostOutcome

a boolean indicating to limit TAR to first per person.

Methods

Public methods

IncidenceDesign$new()

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

Usage

IncidenceDesign$new(data = list())

Arguments

data

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

Returns

A new IncidenceDesign object initialized from a list or JSON string representation of the full design.

IncidenceDesign$toList()

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

Usage

IncidenceDesign$toList()

IncidenceDesign$asJSON()

returns the JSON string for this R6 class

Usage

IncidenceDesign$asJSON(...)

Arguments

...

paramaters that are passed forward to rjsonlite::toJSON()

IncidenceDesign$clone()

The objects of this class are cloneable with this method.

Usage

IncidenceDesign$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.