1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Measure_custom_resampled.R
\name{makeCustomResampledMeasure}
\alias{makeCustomResampledMeasure}
\title{Construct your own resampled performance measure.}
\usage{
makeCustomResampledMeasure(
measure.id,
aggregation.id,
minimize = TRUE,
properties = character(0L),
fun,
extra.args = list(),
best = NULL,
worst = NULL,
measure.name = measure.id,
aggregation.name = aggregation.id,
note = ""
)
}
\arguments{
\item{measure.id}{(\code{character(1)})\cr
Short name of measure.}
\item{aggregation.id}{(\code{character(1)})\cr
Short name of aggregation.}
\item{minimize}{(\code{logical(1)})\cr
Should the measure be minimized?
Default is \code{TRUE}.}
\item{properties}{(\link{character})\cr
Set of measure properties. For a list of values see \link{Measure}.
Default is \code{character(0)}.}
\item{fun}{(\verb{function(task, group, pred, extra.args)})\cr
Calculates performance value from \link{ResamplePrediction} object. For rare
cases you can also use the task, the grouping or the extra arguments
\code{extra.args}.
- \code{task} (\link{Task})\cr
The task.
- \code{group} (\link{factor})\cr
Grouping of resampling iterations. This encodes whether specific
iterations 'belong together' (e.g. repeated CV).
- \code{pred} (\link{Prediction})\cr
Prediction object.
- \code{extra.args} (\link{list})\cr
See below.}
\item{extra.args}{(\link{list})\cr
List of extra arguments which will always be passed to \code{fun}.
Default is empty list.}
\item{best}{(\code{numeric(1)})\cr
Best obtainable value for measure.
Default is -\code{Inf} or \code{Inf}, depending on \code{minimize}.}
\item{worst}{(\code{numeric(1)})\cr
Worst obtainable value for measure.
Default is \code{Inf} or -\code{Inf}, depending on \code{minimize}.}
\item{measure.name}{(\code{character(1)})\cr
Long name of measure.
Default is \code{measure.id}.}
\item{aggregation.name}{(\code{character(1)})\cr
Long name of the aggregation.
Default is \code{aggregation.id}.}
\item{note}{(\link{character}) \cr
Description and additional notes for the measure. Default is \dQuote{}.}
}
\value{
\link{Measure}.
}
\description{
Construct your own performance measure, used after resampling. Note that
individual training / test set performance values will be set to \code{NA}, you
only calculate an aggregated value. If you can define a function that makes
sense for every single training / test set, implement your own \link{Measure}.
}
\seealso{
Other performance:
\code{\link{ConfusionMatrix}},
\code{\link{calculateConfusionMatrix}()},
\code{\link{calculateROCMeasures}()},
\code{\link{estimateRelativeOverfitting}()},
\code{\link{makeCostMeasure}()},
\code{\link{makeMeasure}()},
\code{\link{measures}},
\code{\link{performance}()},
\code{\link{setAggregation}()},
\code{\link{setMeasurePars}()}
}
\concept{performance}
|
