File: makeResampleInstance.Rd

package info (click to toggle)
r-cran-mlr 2.19.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,264 kB
  • sloc: ansic: 65; sh: 13; makefile: 5
file content (69 lines) | stat: -rw-r--r-- 2,275 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ResampleInstance.R
\name{makeResampleInstance}
\alias{makeResampleInstance}
\alias{ResampleInstance}
\title{Instantiates a resampling strategy object.}
\usage{
makeResampleInstance(desc, task, size, ...)
}
\arguments{
\item{desc}{(\link{ResampleDesc} | \code{character(1)})\cr
Resampling description object or name of resampling strategy.
In the latter case \link{makeResampleDesc} will be called internally on the string.}

\item{task}{(\link{Task})\cr
Data of task to resample from.
Prefer to pass this instead of \code{size}.}

\item{size}{(\link{integer})\cr
Size of the data set to resample.
Can be used instead of \code{task}.}

\item{...}{(any)\cr
Passed down to \link{makeResampleDesc} in case
you passed a string in \code{desc}.
Otherwise ignored.}
}
\value{
(\link{ResampleInstance}).
}
\description{
This class encapsulates training and test sets generated from the data set for a number
of iterations. It mainly stores a set of integer vectors indicating the training and
test examples for each iteration.
}
\details{
Object slots:
\describe{
\item{desc (\link{ResampleDesc})}{See argument.}
\item{size (\code{integer(1)})}{See argument.}
\item{train.inds (list of \link{integer})}{List of of training indices for all iterations.}
\item{test.inds (list of \link{integer})}{List of of test indices for all iterations.}
\item{group (\link{factor})}{Optional grouping of resampling iterations. This encodes whether
specific iterations 'belong together' (e.g. repeated CV), and it can later be used to
aggregate performance values accordingly. Default is 'factor()'.}
}
}
\examples{
rdesc = makeResampleDesc("Bootstrap", iters = 10)
rin = makeResampleInstance(rdesc, task = iris.task)

rdesc = makeResampleDesc("CV", iters = 50)
rin = makeResampleInstance(rdesc, size = nrow(iris))

rin = makeResampleInstance("CV", iters = 10, task = iris.task)
}
\seealso{
Other resample: 
\code{\link{ResamplePrediction}},
\code{\link{ResampleResult}},
\code{\link{addRRMeasure}()},
\code{\link{getRRPredictionList}()},
\code{\link{getRRPredictions}()},
\code{\link{getRRTaskDesc}()},
\code{\link{getRRTaskDescription}()},
\code{\link{makeResampleDesc}()},
\code{\link{resample}()}
}
\concept{resample}