createStudyPopulation {PatientLevelPrediction} | R Documentation |
Create a study population
Description
Create a study population
Usage
createStudyPopulation(
plpData,
outcomeId = plpData$metaData$databaseDetails$outcomeIds[1],
populationSettings = createStudyPopulationSettings(),
population = NULL
)
Arguments
plpData |
An object of type |
outcomeId |
The ID of the outcome. |
populationSettings |
An object of class populationSettings created using |
population |
If specified, this population will be used as the starting point instead of the
cohorts in the |
Details
Create a study population by enforcing certain inclusion and exclusion criteria, defining a risk window, and determining which outcomes fall inside the risk window.
Value
A data frame specifying the study population. This data frame will have the following columns:
- rowId
A unique identifier for an exposure
- subjectId
The person ID of the subject
- cohortStartdate
The index date
- outcomeCount
The number of outcomes observed during the risk window
- timeAtRisk
The number of days in the risk window
- survivalTime
The number of days until either the outcome or the end of the risk window
Examples
data("simulationProfile")
plpData <- simulatePlpData(simulationProfile, n = 100)
# Create study population, require time at risk of 30 days. The risk window is 1 to 90 days.
populationSettings <- createStudyPopulationSettings(requireTimeAtRisk = TRUE,
minTimeAtRisk = 30,
riskWindowStart = 1,
riskWindowEnd = 90)
population <- createStudyPopulation(plpData, outcomeId = 3, populationSettings)