drawAttritionDiagramPlp: Draw the attrition diagram

Description Usage Arguments Value

View source: R/AttritionDiagramPlp.R

Description

drawAttritionDiagramPlp draws the attition diagram, showing how many people were excluded from the study population, and for what reasons.

Usage

1
2
3
4
5
6
drawAttritionDiagramPlp(
  attrition,
  targetLabel = "Target Population",
  outcomeLabel = "Outcome Count",
  fileName = NULL
)

Arguments

attrition

The table of attrition details return from the population attr(popualtion, 'metaData')$attrition

targetLabel

A label to us for the treated cohort.

outcomeLabel

A label to us for the comparator cohort.

fileName

Name of the file where the plot should be saved, for example 'plot.png'. See the function ggsave in the ggplot2 package for supported file formats.

Value

A ggplot object. Use the ggsave function to save to file in a different format.


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