plotLearningCurve: plotLearningCurve

In quinterpriest/PatientLevelPrediction: Developing patient level prediction using data in the OMOP Common Data Model

plotLearningCurve

Description

Create a plot of the learning curve using the object returned from createLearningCurve.

Usage

plotLearningCurve(
  learningCurve,
  metric = "AUROC",
  abscissa = "events",
  plotTitle = "Learning Curve",
  plotSubtitle = NULL,
  fileName = NULL
)

Arguments

learningCurve	An object returned by createLearningCurve function.
metric	Specifies the metric to be plotted: 'AUROC' - use the area under the Receiver Operating Characteristic curve 'AUPRC' - use the area under the Precision-Recall curve 'sBrier' - use the scaled Brier score
abscissa	Specify the abscissa metric to be plotted: 'events' - use number of events 'observations' - use number of observations
plotTitle	Title of the learning curve plot.
plotSubtitle	Subtitle of the learning curve plot.
fileName	Filename of plot to 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.

Examples

## Not run: 
# create learning curve object
learningCurve <- createLearningCurve(population,
                                     plpData,
                                     modelSettings)
# plot the learning curve
plotLearningCurve(learningCurve)

## End(Not run)

quinterpriest/PatientLevelPrediction documentation built on April 20, 2022, 12:50 a.m.