riskchart: Plot a risk chart

View source: R/riskchart.R

riskchartR Documentation

Plot a risk chart


Plots a Rattle Risk Chart for binary classification models using ggplot2. Such a chart has been developed in a practical context to present the performance of data mining models to clients, plotting a caseload against performance, allowing a client to see the tradeoff between coverage and performance.


          ri               = NULL,
          title            = "Risk Chart",
          title.size       = 10,
          subtitle         = NULL,
          caption          = TRUE,
          show.legend      = TRUE,
          optimal          = NULL,
          optimal.label    = "",
          chosen           = NULL,
          chosen.label     = "",
          include.baseline = TRUE,
          dev              = "",
          filename         = "",
          show.knots       = NULL,
          show.lift        = TRUE,
          show.precision   = TRUE,
          show.maximal     = TRUE,
          risk.name        = "Risk",
          recall.name      = "Recall",
          precision.name   = "Precision",
          thresholds       = NULL,
          legend.horiz     = TRUE)



The predicted class for each observation.


The actual class for each observation.


The risk class for each observation.


the main title to place at the top of the plot.


font size for the main title.


subtitle under the main title.


caption for the bottom right of plot.


whether to display the legend in the plot.


a caseload (percentage or fraction) that represents an optimal performance point which is also plotted. If instead the value is TRUE then the optimal point is identified internally (maximum valud for (recall-casload)+(risk-caseload)) and plotted.


a string which is added to label the line drawn as the optimal point.


a caseload (percentage or fraction) that represents a user chosen optimal performance point which is also plotted.


a string which is added to label the line drawn as the chosen point.


if TRUE (the default) then display the diagonal baseline.


a string which, if supplied, identifies a device type as the target for the plot. This might be one of wmf (for generating a Windows Metafile, but only available on MS/Windows), pdf, or png.


a string naming a file. If dev is not given then the filename extension is used to identify the image format as one of those recognised by the dev argument.


a vector of caseload values at which a vertical line should be drawn. These might correspond, for example, to individual paths through a decision tree, illustrating the impact of each path on the caseload and performance.


whether to label the right axis with lift.


whether to show the precision plot.


whether to show the maximal performance line.


a string used within the plot's legend that gives a name to the risk. Often the risk is a dollar amount at risk from a fraud or from a bank loan point of view, so the default is Revenue.


a string used within the plot's legend that gives a name to the recall. The recall is often the percentage of cases that are positive hits, and in practise these might correspond to known cases of fraud or reviews where some adjustment to perhaps a incom tax return or application for credit had to be made on reviewing the case, and so the default is Adjustments.


a string used within the plot's legend that gives a name to the precision. A common name for precision is Strike Rate, which is the default here.


whether to display scores along the top axis.


whether to display a horizontal legend.


Caseload is the percentage of the entities in the dataset covered by the model at a particular probability cutoff, so that with a cutoff of 0, all (100%) of the entities are covered by the model. With a cutoff of 1 (0%) no entities are covered by the model. A diagonal line is drawn to represent a baseline random performance. Then the percentage of positive cases (the recall) covered for a particular caseload is plotted, and optionally a measure of the percentage of the total risk that is also covered for a particular caseload may be plotted. Such a chart allows a user to select an appropriate tradeoff between caseload and performance. The charts are similar to ROC curves. The precision (i.e., strike rate) is also plotted.




Package home page: https://rattle.togaware.com

See Also

evaluateRisk, genPlotTitleCmd.


## Not run: 

## Use rpart to build a decision tree.


## Set up the data for modelling.

ds     <- weather
target <- "RainTomorrow"
risk   <- "RISK_MM"
ignore <- c("Date", "Location", risk)
vars   <- setdiff(names(ds), ignore)
nobs   <- nrow(ds)
form   <- formula(paste(target, "~ ."))
train  <- sample(nobs, 0.7*nobs)
test   <- setdiff(seq_len(nobs), train)
actual <- ds[test, target]
risks  <- ds[test, risk]

# Build the model.

model <- rpart(form, data=ds[train, vars])

## Obtain predictions.

predicted <- predict(model, ds[test, vars], type="prob")[,2]

## Plot the Risk Chart.

riskchart(predicted, actual, risks)

## End(Not run)

rattle documentation built on March 21, 2022, 5:06 p.m.