This vignette describes how you can use the CohortMethod
package to perform a single new-user cohort study. We will walk through
all the steps needed to perform an exemplar study, and we have selected
the well-studied topic of the effect of coxibs versus non-selective
non-steroidal anti-inflammatory drugs (NSAIDs) on gastrointestinal (GI)
bleeding-related hospitalization. For simplicity, we focus on one coxib
– celecoxib – and one non-selective NSAID – diclofenac.
The first step in running the CohortMethod is extracting
all necessary data from the database server holding the data in the
Observational Medical Outcomes Partnership (OMOP) Common Data Model
(CDM) format.
We need to tell R how to connect to the server where the data are.
CohortMethod uses the DatabaseConnector
package, which provides the createConnectionDetails
function. Type ?createConnectionDetails for the specific
settings required for the various database management systems (DBMS).
For example, one might connect to a PostgreSQL database using this
code:
library(CohortMethod)
connectionDetails <- createConnectionDetails(dbms = "postgresql",
server = "localhost/ohdsi",
user = "joe",
password = "supersecret")
cdmDatabaseSchema <- "my_cdm_data"
cohortDatabaseSchema <- "my_results"
cohortTable <- "my_cohorts"
options(sqlRenderTempEmulationSchema = NULL)The last few lines define the cdmDatabaseSchema,
cohortDatabaseSchema, and cohortTable
variables. We’ll use these later to tell R where the data in CDM format
live, and where we want to write intermediate tables. Note that for
Microsoft SQL Server, databaseschemas need to specify both the database
and the schema, so for example
cdmDatabaseSchema <- "my_cdm_data.dbo". For database
platforms that do not support temp tables, such as Oracle, it is also
necessary to provide a schema where the user has write access that can
be used to emulate temp tables. PostgreSQL supports temp tables, so we
can set options(sqlRenderTempEmulationSchema = NULL) (or
not set the sqlRenderTempEmulationSchema at all.)
We need to define the exposures and outcomes for our study. Here, we
will define our exposures using the OHDSI Capr package. We
define two exposure cohorts, one for celecoxib and one for diclofenac.
It is often a good idea to restrict your analysis to a specific
indication, to maximize the comparability of the two cohorts. In this
case, we will restrict to osteoarthritis of the knee. We will create a
cohort for this indication, starting a the first ever diagnosis, and
ending at observation period end.
library(Capr)
celecoxibConceptId <- 1118084
diclofenacConceptId <- 1124300
osteoArthritisOfKneeConceptId <- 4079750
celecoxib <- cs(
descendants(celecoxibConceptId),
name = "Celecoxib"
)
celecoxibCohort <- cohort(
entry = entry(
drugExposure(celecoxib)
),
exit = exit(endStrategy = drugExit(celecoxib,
persistenceWindow = 30,
surveillanceWindow = 0))
)
diclofenac <- cs(
descendants(diclofenacConceptId),
name = "Diclofenac"
)
diclofenacCohort <- cohort(
entry = entry(
drugExposure(diclofenac)
),
exit = exit(endStrategy = drugExit(diclofenac,
persistenceWindow = 30,
surveillanceWindow = 0))
)
osteoArthritisOfKnee <- cs(
descendants(osteoArthritisOfKneeConceptId),
name = "Osteoarthritis of knee"
)
osteoArthritisOfKneeCohort <- cohort(
entry = entry(
conditionOccurrence(osteoArthritisOfKnee, firstOccurrence())
),
exit = exit(
endStrategy = observationExit()
)
)
# Note: this will automatically assign cohort IDs 1,2, and 3, respectively:
exposuresAndIndicationCohorts <- makeCohortSet(celecoxibCohort,
diclofenacCohort,
osteoArthritisOfKneeCohort)We’ll pull the outcome definition from the OHDSI
PhenotypeLibrary:
We combine the exposure and outcome cohort definitions, and use
CohortGenerator to generate the cohorts:
allCohorts <- bind_rows(outcomeCohorts,
exposuresAndIndicationCohorts)
library(CohortGenerator)
cohortTableNames <- getCohortTableNames(cohortTable = cohortTable)
createCohortTables(connectionDetails = connectionDetails,
cohortDatabaseSchema = cohortDatabaseSchema,
cohortTableNames = cohortTableNames)
generateCohortSet(connectionDetails = connectionDetails,
cdmDatabaseSchema = cdmDatabaseSchema,
cohortDatabaseSchema = cohortDatabaseSchema,
cohortTableNames = cohortTableNames,
cohortDefinitionSet = allCohorts)If all went well, we now have a table with the cohorts of interest. We can see how many entries per cohort:
connection <- DatabaseConnector::connect(connectionDetails)
sql <- "SELECT cohort_definition_id, COUNT(*) AS count
FROM @cohortDatabaseSchema.@cohortTable
GROUP BY cohort_definition_id"
cohortCounts <- DatabaseConnector::renderTranslateQuerySql(
connection = connection,
sql = sql,
cohortDatabaseSchema = cohortDatabaseSchema,
cohortTable = cohortTable
)
DatabaseConnector::disconnect(connection)## cohort_concept_id count
## 1 1 917230
## 2 2 1791695
## 3 3 993116
## 4 77 1123643
Now we can tell CohortMethod to extract the cohorts,
construct covariates, and extract all necessary data for our
analysis.
Important: The target and comparator drug must not
be included in the covariates, including any descendant concepts. You
will need to manually add the drugs and descendants to the
excludedCovariateConceptIds of the covariate settings. In
this example code we exclude the concepts for celecoxib and diclofenac
and specify addDescendantsToExclude = TRUE:
# Define which types of covariates must be constructed:
covSettings <- createDefaultCovariateSettings(
excludedCovariateConceptIds = c(diclofenacConceptId, celecoxibConceptId),
addDescendantsToExclude = TRUE
)
#Load data:
cohortMethodData <- getDbCohortMethodData(
connectionDetails = connectionDetails,
cdmDatabaseSchema = cdmDatabaseSchema,
targetId = 1,
comparatorId = 2,
outcomeIds = 77,
exposureDatabaseSchema = cohortDatabaseSchema,
exposureTable = cohortTable,
outcomeDatabaseSchema = cohortDatabaseSchema,
outcomeTable = cohortTable,
nestingCohortDatabaseSchema = cohortDatabaseSchema,
nestingCohortTable = cohortTable,
getDbCohortMethodDataArgs = createGetDbCohortMethodDataArgs(
removeDuplicateSubjects = "keep first, truncate to second",
firstExposureOnly = TRUE,
washoutPeriod = 365,
restrictToCommonPeriod = TRUE,
nestingCohortId = 3,
covariateSettings = covSettings
)
)
cohortMethodDataThere are many parameters, but they are all documented in the
CohortMethod manual. The
createDefaultCovariateSettings function is described in the
FeatureExtraction package. In short, we are pointing the
function to the table created earlier and indicating which concept IDs
in that table identify the target, comparator, nesting cohort and
outcome. We instruct that the default set of covariates should be
constructed, including covariates for all conditions, drug exposures,
and procedures that were found on or before the index date. To customize
the set of covariates, please refer to the
FeatureExtraction package vignette by typing
vignette("UsingFeatureExtraction", package="FeatureExtraction").
We let the CohortMethod package construct our sets of
new users: - For those patients who have exposure to both the target and
the comparator, we keep whichever is their first, and truncate their
exposure at the start of the second (if the first occurrences of the
target and comparator start simultaneously the patient is removed). - We
restrict to the first exposure overall (in this case redundant with the
previous step). - We require a washout period of 365 days, meaning any
patients with less than 365 days of prior observation are removed. - We
restrict to the period in time when both drugs were observed in the
database. This can be especially helpful when one of the exposures is
new to the market. - We restrict to the nesting cohort, in this case our
indication. Only exposures within the nesting cohort are kept.
We can see how many persons and exposures were left after each of these steps:
The
cohortMethodData() function extracts all data about the exposures, outcomes, and covariates from the server and stores them in thecohortMethodDataobject. This object uses theAndromedapackage to store information in a way that ensures R does not run out of memory, even when the data are large. We can use the genericsummary()`
function to view some more information of the data we extracted:
Creating the cohortMethodData file can take considerable
computing time, and it is probably a good idea to save it for future
sessions. Because cohortMethodData uses
Andromeda, we cannot use R’s regular save function.
Instead, we’ll have to use the saveCohortMethodData()
function:
We can use the loadCohortMethodData() function to load
the data in a future session.
Typically, the exposure cohorts and outcome cohorts will be defined
independently of each other. When we want to produce an effect size
estimate, we need to further restrict these cohorts and put them
together, for example by removing exposed subjects that had the outcome
prior to exposure, and only keeping outcomes that fall within a defined
risk window. For this we can use the createStudyPopulation
function:
studyPop <- createStudyPopulation(
cohortMethodData = cohortMethodData,
outcomeId = 77,
createStudyPopulationArgs = createCreateStudyPopulationArgs(
removeSubjectsWithPriorOutcome = TRUE,
priorOutcomeLookback = 365,
minDaysAtRisk = 1,
riskWindowStart = 0,
startAnchor = "cohort start",
riskWindowEnd = 30,
endAnchor = "cohort end"
)
)We specify the outcome ID we will use, and that people who had the
outcomes in the 365 days before the risk window start date will be
removed. The risk window is defined as starting at the cohort start date
(the index date, riskWindowStart = 0 and
startAnchor = "cohort start"), and the risk windows ends 30
days after the cohort ends (riskWindowEnd = 30 and
endAnchor = "cohort end"). Note that the risk windows are
truncated at the end of observation or the study end date. We also
remove subjects who have no time at risk. To see how many people are
left in the study population we can always use the
getAttritionTable function:
The CohortMethod can use propensity scores to adjust for
potential confounders. Instead of the traditional approach of using a
handful of predefined covariates, CohortMethod typically
uses tens of thousands of covariates that are automatically constructed
based on conditions, procedures and drugs in the records of the
subjects.
We can fit a propensity model using the covariates constructed by the
getDbcohortMethodData() function:
The createPs() function uses the Cyclops
package to fit a large-scale regularized logistic regression.
To fit the propensity model, Cyclops needs to know the
hyperparameter value which specifies the variance of the prior. By
default Cyclops will use cross-validation to estimate the
optimal hyperparameter. However, be aware that this can take a really
long time. You can use the prior and control
parameters of the createPs() to specify
Cyclops behavior, including using multiple CPUs to speed-up
the cross-validation.
We can compute the area under the receiver-operator curve (AUC) for the propensity score model:
We can also plot the propensity score distribution. By default, the
plotPS() function shows the preference score, a
transformation of the propensity score that adjusts for differences in
sizes between the target and comparator:
plotPs(ps,
targetLabel = "Celexocib",
comparatorLabel = "Diclofenac",
showCountsLabel = TRUE,
showAucLabel = TRUE,
showEquipoiseLabel = TRUE)It is also possible to inspect the propensity model itself by showing the covariates that have non-zero coefficients:
One advantage of using the regularization when fitting the propensity model is that most coefficients will shrink to zero and fall out of the model. It is a good idea to inspect the remaining variables for anything that should not be there, for example variations of the drugs of interest that we forgot to exclude.
Finally, we can inspect the percent of the population in equipoise, meaning they have a preference score between 0.3 and 0.7:
A low equipoise indicates there is little overlap between the target and comparator populations.
We can use the propensity scores to trim, stratify, match, or weigh our population. For example, one could trim to equipoise, meaning only subjects with a preference score between 0.3 and 0.7 are kept:
trimmedPop <- trimByPs(ps,
trimByPsArgs = createTrimByPsArgs(
equipoiseBounds = c(0.3, 0.7)
))
# Note: we need to also provide the original PS object so the preference score
# is computed using the original relative sizes of the cohorts:
plotPs(trimmedPop, ps)Instead (or additionally), we could stratify the population based on the propensity score:
stratifiedPop <- stratifyByPs(ps,
stratifyByPsArgs = createStratifyByPsArgs(
numberOfStrata = 5
))
plotPs(stratifiedPop)We can also match subjects based on propensity scores. In this
example, we’re using one-to-one matching. By default,
createPs() will use a caliper of 0.2 on the standardized
logit scale:
matchedPop <- matchOnPs(ps,
matchOnPsArgs = createMatchOnPsArgs(
maxRatio = 1
))
plotPs(matchedPop, ps)We can see the effect of trimming and/or matching on the population
using the getAttritionTable function:
Or, if we like, we can plot an attrition diagram:
To evaluate whether our use of the propensity score is indeed making the two cohorts more comparable, we can compute the covariate balance before and after trimming, matching, and/or stratifying:
The ‘before matching’ population is the population as extracted by
the getDbCohortMethodData function, so before any further
filtering steps. We typically consider the populations to be balanced
if, after PS adjustment, all covariates have a standardized difference
of means smaller than 0.1.
It is customary to include a table in your paper that lists some
select population characteristics before and after
matching/stratification/trimming. This is usually the first table, and
so will be referred to as ‘table 1’. To generate this table, you can use
the createCmTable1 function:
The goal of any propensity score adjustments is typically to make the
target and comparator cohorts comparably, to allow proper causal
inference. However, in doing so, we often need to modify our population,
for example dropping subjects that have no counterpart in the other
exposure cohort. The population we end up estimating an effect for may
end up being very different from the population we started with. An
important question is: how different? And it what ways? If the
populations before and after adjustment are very different, our
estimated effect may not generalize to the original population (if
effect modification is present). The
getGeneralizabilityTable() function informs on these
differences:
In this case, because we used PS matching, we are likely aiming to
estimate the average treatment effect in the treated (ATT). For this
reason, the getGeneralizabilityTable() function
automatically selected the target cohort as the basis for evaluating
generalizability: it shows, for each covariate, the mean value before
and PS adjustment in the target cohort. Also shown is the standardized
difference of mean, and the table is reverse sorted by the absolute
standard difference of mean (ASDM).
Before we start fitting an outcome model, we might be interested to know whether we have sufficient power to detect a particular effect size. It makes sense to perform these power calculations once the study population has been fully defined, so taking into account loss to the various inclusion and exclusion criteria (such as no prior outcomes), and loss due to matching and/or trimming. Since the sample size is fixed in retrospective studies (the data has already been collected), and the true effect size is unknown, the CohortMethod package provides a function to compute the minimum detectable relative risk (MDRR) instead:
In this example we used the studyPop object, so the
population before any matching or trimming. If we want to know the MDRR
after matching, we use the matchedPop object we created
earlier instead:
computeMdrr(
population = matchedPop,
modelType = "cox",
alpha = 0.05,
power = 0.8,
twoSided = TRUE
)Even thought the MDRR in the matched population is higher, meaning we have less power, we should of course not be fooled: matching most likely eliminates confounding, and is therefore preferred to not matching.
To gain a better understanding of the amount of follow-up available
we can also inspect the distribution of follow-up time. We defined
follow-up time as time at risk, so not censored by the occurrence of the
outcome. The getFollowUpDistribution can provide a simple
overview:
The output is telling us number of days of follow-up each quantile of the study population has. We can also plot the distribution:
The outcome model is a model describing which variables are associated with the outcome.
In theory we could fit an outcome model without using the propensity scores. In this example we are fitting an outcome model using a Cox regression:
outcomeModel <- fitOutcomeModel(
population = studyPop,
fitOutcomeModelArgs = createFitOutcomeModelArgs(
modelType = "cox"
)
)
outcomeModelBut of course we want to make use of the matching done on the propensity score:
outcomeModel <- fitOutcomeModel(
population = matchedPop,
fitOutcomeModelArgs = createFitOutcomeModelArgs(
modelType = "cox"
)
)
outcomeModelNote that we define the sub-population to be only those in the
matchedPop object, which we created earlier by matching on
the propensity score.
Instead of matching or stratifying we can also perform Inverse Probability of Treatment Weighting (IPTW):
outcomeModel <- fitOutcomeModel(
population = ps,
fitOutcomeModelArgs = createFitOutcomeModelArgs(
modelType = "cox",
inversePtWeighting = TRUE,
bootstrapCi = TRUE
)
)
outcomeModelNote that in this case we may want to use a bootstrap to compute the confidence interval.
We may be interested whether the effect is different across different groups in the population. To explore this, we may include interaction terms in the model. In this example we include three interaction terms:
interactionCovariateIds <- c(8532001, 201826210, 21600960413)
# 8532001 = Female
# 201826210 = Type 2 Diabetes
# 21600960413 = Concurent use of antithrombotic agents
outcomeModel <- fitOutcomeModel(
population = matchedPop,
cohortMethodData = cohortMethodData,
fitOutcomeModelArgs = createFitOutcomeModelArgs(
modelType = "cox",
interactionCovariateIds = interactionCovariateIds
)
)
outcomeModelIt is prudent to verify that covariate balance has also been achieved in the subgroups of interest. For example, we can check the covariate balance in the subpopulation of females:
One final refinement would be to use the same covariates we used to
fit the propensity model to also fit the outcome model. This way we are
more robust against misspecification of the model, and more likely to
remove bias. For this we use the regularized Cox regression in the
Cyclops package. (Note that the treatment variable is
automatically excluded from regularization.)
We can inspect more details of the outcome model:
We can also see the covariates that ended up in the outcome model:
We can create the Kaplan-Meier plot:
Note that the Kaplan-Meier plot will automatically adjust for any stratification, matching, or trimming that may have been applied.
We can also plot time-to-event, showing both events before and after the index date, and events during and outside the defined time-at-risk window. This plot can provide insight into the temporal pattern of the outcome relative to the exposures:
plotTimeToEvent(
cohortMethodData = cohortMethodData,
outcomeId = 77,
minDaysAtRisk = 1,
riskWindowStart = 0,
startAnchor = "cohort start",
riskWindowEnd = 30,
endAnchor = "cohort end"
)Note that this plot does not show any adjustment for the propensity score.
Considerable work has been dedicated to provide the
CohortMethod package.
## To cite CohortMethod in publications use:
##
## Schuemie MJ, Reps JM, Black A, DeFalco F, Evans L, Fridgeirsson E,
## Gilbert JP, Knoll C, Lavallee M, Rao G, Rijnbeek P, Sadowski K, Sena
## A, Swerdel J, Williams RD, Suchard MA (2024). "Health-analytics data
## to evidence suite (HADES): open-source software for observational
## research." _Studies in Health Technology and Informatics_, *310*,
## 966-970. doi:10.3233/SHTI231108 <https://doi.org/10.3233/SHTI231108>.
## <https://doi.org/10.3233/shti231108>.
##
## A BibTeX entry for LaTeX users is
##
## @Article{,
## title = {Health-analytics data to evidence suite (HADES): open-source software for observational research},
## author = {M. J. Schuemie and J. M. Reps and A. Black and F. DeFalco and L. Evans and E. Fridgeirsson and J. P. Gilbert and C. Knoll and M. Lavallee and G. Rao and P. Rijnbeek and K. Sadowski and A. Sena and J. Swerdel and R. D. Williams and M. A. Suchard},
## journal = {Studies in Health Technology and Informatics},
## year = {2024},
## volume = {310},
## pages = {966-970},
## doi = {10.3233/SHTI231108},
## url = {https://doi.org/10.3233/shti231108},
## }
Further, CohortMethod makes extensive use of the
Cyclops package.
## To cite Cyclops in publications use:
##
## Suchard MA, Simpson SE, Zorych I, Ryan P, Madigan D (2013). "Massive
## parallelization of serial inference algorithms for complex
## generalized linear models." _ACM Transactions on Modeling and
## Computer Simulation_, *23*, 10. doi:10.1145/2414416.2414791
## <https://doi.org/10.1145/2414416.2414791>.
##
## A BibTeX entry for LaTeX users is
##
## @Article{,
## author = {M. A. Suchard and S. E. Simpson and I. Zorych and P. Ryan and D. Madigan},
## title = {Massive parallelization of serial inference algorithms for complex generalized linear models},
## journal = {ACM Transactions on Modeling and Computer Simulation},
## volume = {23},
## pages = {10},
## year = {2013},
## doi = {10.1145/2414416.2414791},
## }
This work is supported in part through the National Science Foundation grant IIS 1251151.