getCohortNames: getCohortNames

Description Usage Arguments Details Value Examples

Description

Extracts the names of the cohorts in the CohortList is a FAIRsimulator study object.

Usage

1
getCohortNames(StudyObj)

Arguments

StudyObj

A FAIRsimulator study object.

Details

This is an internal function that extracts the values of the Name slot in the CohortList list of a FAIRsimulator study object. It is typically used to set the names of the CohortList components, so that they can be extracted using names(CohortList) and referred to by name, e.g. CohortList[[cohortName]].

Value

A character vector

Examples

1
2
3
4
## Not run: 
names(StudyObj$CohortList) <- getCohortNames(StudyObj)

## End(Not run)

eniclas/FAIRsimulator documentation built on May 16, 2019, 5:12 a.m.