outcomeSurvivalPlot: Plot the outcome incidence over time

View source: R/Plotting.R

outcomeSurvivalPlotR Documentation

Plot the outcome incidence over time

Description

Plot the outcome incidence over time

Usage

outcomeSurvivalPlot(
  plpData,
  outcomeId,
  populationSettings = createStudyPopulationSettings(binary = T, includeAllOutcomes = T,
    firstExposureOnly = FALSE, washoutPeriod = 0, removeSubjectsWithPriorOutcome = TRUE,
    priorOutcomeLookback = 99999, requireTimeAtRisk = F, riskWindowStart = 1, startAnchor
    = "cohort start", riskWindowEnd = 3650, endAnchor = "cohort start"),
  riskTable = T,
  confInt = T,
  yLabel = "Fraction of those who are outcome free in target population"
)

Arguments

plpData

The plpData object returned by running getPlpData()

outcomeId

The cohort id corresponding to the outcome

populationSettings

The population settings created using createStudyPopulationSettings

riskTable

(binary) Whether to include a table at the bottom of the plot showing the number of people at risk over time

confInt

(binary) Whether to include a confidence interval

yLabel

(string) The label for the y-axis

Details

This creates a survival plot that can be used to pick a suitable time-at-risk period

Value

TRUE if it ran


OHDSI/PatientLevelPrediction documentation built on April 27, 2024, 8:11 p.m.