executeCohortPathways {CohortPathways} | R Documentation |
Execute cohort pathway analysis.
Description
Runs the cohort pathways on all instantiated combinations of target and event cohorts. Assumes the cohorts have already been instantiated.
Usage
executeCohortPathways(
connectionDetails = NULL,
connection = NULL,
cohortDatabaseSchema,
cohortTableName = "cohort",
tempEmulationSchema = getOption("sqlRenderTempEmulationSchema"),
targetCohortIds,
eventCohortIds,
minCellCount = 5,
allowRepeats = FALSE,
maxDepth = 5,
collapseWindow = 30
)
Arguments
connectionDetails |
An object of type connectionDetails as created using the
|
connection |
An object of type |
cohortDatabaseSchema |
Schema name where your cohort tables reside. Note that for SQL Server, this should include both the database and schema name, for example 'scratch.dbo'. |
cohortTableName |
The name of the cohort table. |
tempEmulationSchema |
Some database platforms like Oracle and Impala do not truly support temp tables. To emulate temp tables, provide a schema with write privileges where temp tables can be created. |
targetCohortIds |
A vector of one or more Cohort Ids corresponding to target cohort (s). |
eventCohortIds |
A vector of one or more Cohort Ids corresponding to event cohort (s). |
minCellCount |
(Default = 5) The minimum cell count for fields contains person counts or fractions. |
allowRepeats |
(Default = FALSE) Allow cohort events/combos to appear multiple times in the same pathway. |
maxDepth |
(Default = 5) Maximum number of steps in a given pathway to be included in the sunburst plot |
collapseWindow |
(Default = 30) Any dates found within the specified collapse days will be reassigned the earliest date. Collapsing dates reduces pathway variation, leading to a reduction in 'noise' in the result. |
Value
An array of Data Frame objects.
Examples
## Not run:
executeCohortPathways(
connectionDetails = connectionDetails,
cohorts = cohorts,
cohortDatabaseSchema = "results"
)
## End(Not run)