Usage
plotRisk(cl, pr, re, ri = NULL, title = NULL,
show.legend = TRUE, xleg = 20, yleg = 16,
optimal = NULL, optimal.label = "", chosen = NULL, chosen.label = "",
include.baseline = TRUE, dev = "", filename = "", show.knots = NULL,
show.lift=TRUE, show.precision=TRUE,
risk.name = "Risk", recall.name = "Recall",
precision.name = "Precision")
Arguments
cl
a vector of caseloads corresponding to different probability
cutoffs. Can be either percentages (between 0 and 100) or fractions
(between 0 and 1).
pr
a vector of precision values for each probability
cutoff. Can be either percentages (between 0 and 100) or fractions
(between 0 and 1).
re
a vector of recall values for each probability cutoff. Can
be either percentages (between 0 and 100) or fractions (between 0
and 1).
ri
a vector of risk values for each probability cutoff. Can be
either percentages (between 0 and 100) or fractions (between 0 and
1).
title
the main title to place at the top of the plot.
show.legend
whether to display the legend in the plot.
xleg
the x coordinate for the placement of the legend.
yleg
the y coordinate for the placement of the legend.
optimal
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-caseloa
optimal.label
a string which is added to label the line drawn
as the optimal point.
chosen
a caseload (percentage or fraction) that represents a
user chosen optimal performance point which is also plotted.
chosen.label
a string which is added to label the line drawn as
the chosen point.
include.baseline
if TRUE (the default) then display the
diagonal baseline.
dev
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
.
filename
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.
show.knots
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.
show.lift
whether to label the right axis with lift.
show.precision
whether to show the precision plot.
risk.name
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
.
recall.name
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
precision.name
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.