document cohortId

OHDSI · Sep 4, 2024 · f65aa56 · f65aa56
1 parent ec92dd5
commit f65aa56
Show file tree

Hide file tree

Showing 32 changed files with 66 additions and 33 deletions.
diff --git a/R/documentationHelper.R b/R/documentationHelper.R
@@ -11,7 +11,8 @@ NULL
 
 #' Helper for consistent documentation of `cohortId`.
 #'
-#' @param cohortId IDs of the cohorts to include. Cohorts not included will be
+#' @param cohortId Vector identifying which cohorts to include
+#' (cohort_definition_id or cohort_name). Cohorts not included will be
 #' removed from the cohort set.
 #'
 #' @name cohortIdSubsetDoc
@@ -21,7 +22,8 @@ NULL
 
 #' Helper for consistent documentation of `cohortId`.
 #'
-#' @param cohortId IDs of the cohorts to modify. If NULL, all cohorts will be
+#' @param 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.
 #'

diff --git a/man/cohortIdModifyDoc.Rd b/man/cohortIdModifyDoc.Rd
diff --git a/man/cohortIdSubsetDoc.Rd b/man/cohortIdSubsetDoc.Rd
diff --git a/man/collapseCohorts.Rd b/man/collapseCohorts.Rd
diff --git a/man/entryAtFirstDate.Rd b/man/entryAtFirstDate.Rd
diff --git a/man/entryAtLastDate.Rd b/man/entryAtLastDate.Rd
diff --git a/man/exitAtDeath.Rd b/man/exitAtDeath.Rd
diff --git a/man/exitAtFirstDate.Rd b/man/exitAtFirstDate.Rd
diff --git a/man/exitAtLastDate.Rd b/man/exitAtLastDate.Rd
diff --git a/man/exitAtObservationEnd.Rd b/man/exitAtObservationEnd.Rd
diff --git a/man/intersectCohorts.Rd b/man/intersectCohorts.Rd
diff --git a/man/matchCohorts.Rd b/man/matchCohorts.Rd
diff --git a/man/padCohortStart.Rd b/man/padCohortStart.Rd
diff --git a/man/requireAge.Rd b/man/requireAge.Rd
diff --git a/man/requireCohortIntersect.Rd b/man/requireCohortIntersect.Rd
diff --git a/man/requireConceptIntersect.Rd b/man/requireConceptIntersect.Rd
diff --git a/man/requireDeathFlag.Rd b/man/requireDeathFlag.Rd
diff --git a/man/requireDemographics.Rd b/man/requireDemographics.Rd
diff --git a/man/requireFutureObservation.Rd b/man/requireFutureObservation.Rd
diff --git a/man/requireInDateRange.Rd b/man/requireInDateRange.Rd
diff --git a/man/requireIsEntry.Rd b/man/requireIsEntry.Rd
diff --git a/man/requireIsFirstEntry.Rd b/man/requireIsFirstEntry.Rd
diff --git a/man/requireMinCohortCount.Rd b/man/requireMinCohortCount.Rd
diff --git a/man/requirePriorObservation.Rd b/man/requirePriorObservation.Rd
diff --git a/man/requireSex.Rd b/man/requireSex.Rd
diff --git a/man/requireTableIntersect.Rd b/man/requireTableIntersect.Rd
diff --git a/man/sampleCohorts.Rd b/man/sampleCohorts.Rd
diff --git a/man/stratifyCohorts.Rd b/man/stratifyCohorts.Rd
diff --git a/man/subsetCohorts.Rd b/man/subsetCohorts.Rd
diff --git a/man/trimDemographics.Rd b/man/trimDemographics.Rd
diff --git a/man/unionCohorts.Rd b/man/unionCohorts.Rd
diff --git a/man/yearCohorts.Rd b/man/yearCohorts.Rd