outcomeSurvivalPlot: Plot the outcome incidence over time

Description Usage Arguments Details Value

View source: R/Plotting.R

Description

Plot the outcome incidence over time

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
outcomeSurvivalPlot(
  plpData,
  outcomeId,
  removeSubjectsWithPriorOutcome = T,
  riskWindowStart = 1,
  riskWindowEnd = 3650,
  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

removeSubjectsWithPriorOutcome

Remove patients who have had the outcome before their target cohort index date from the plot

riskWindowStart

(integer) The time-at-risk starts at target cohort index date plus this value

riskWindowEnd

(integer) The time-at-risk ends at target cohort index date plus this value

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


hxia/plp-git-demo documentation built on March 19, 2021, 1:54 a.m.