renameCohort {CohortConstructor} | R Documentation |
Utility function to change the name of a cohort.
Description
Utility function to change the name of a cohort.
Usage
renameCohort(cohort, cohortId, newCohortName, .softValidation = TRUE)
Arguments
cohort |
A cohort table in a cdm reference. |
cohortId |
Vector identifying which cohorts to modify (cohort_definition_id or cohort_name). If NULL, all cohorts will be used; otherwise, only the specified cohorts will be modified, and the rest will remain unchanged. |
newCohortName |
Character vector with same |
.softValidation |
Whether to perform a soft validation of consistency. If set to FALSE four additional checks will be performed: 1) a check that cohort end date is not before cohort start date, 2) a check that there are no missing values in required columns, 3) a check that cohort duration is all within observation period, and 4) that there are no overlapping cohort entries |
Value
A cohort_table object.
Examples
library(CohortConstructor)
cdm <- mockCohortConstructor(nPerson = 100)
settings(cdm$cohort1)
cdm$cohort1 <- cdm$cohort1 |>
renameCohort(cohortId = 1, newCohortName = "new_name")
settings(cdm$cohort1)
[Package CohortConstructor version 0.4.0 Index]