File: Prediction.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 (47 lines) | stat: -rw-r--r-- 1,605 bytes parent folder | download | duplicates (3)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Prediction.R
\name{Prediction}
\alias{Prediction}
\alias{makePrediction}
\title{Prediction object.}
\usage{
makePrediction(
  task.desc,
  row.names,
  id,
  truth,
  predict.type,
  predict.threshold = NULL,
  y,
  time,
  error = NA_character_,
  dump = NULL
)
}
\description{
Result from \link{predict.WrappedModel}.
Use \code{as.data.frame} to access all information in a convenient format.
The function \link{getPredictionProbabilities} is useful to access predicted probabilities.

The \code{data} member of the object contains always the following columns:
\code{id}, index numbers of predicted cases from the task, \code{response}
either a numeric or a factor, the predicted response values, \code{truth},
either a numeric or a factor, the true target values.
If probabilities were predicted, as many numeric columns as there were classes named
\code{prob.classname}. If standard errors were predicted, a numeric column named \code{se}.

The constructor \code{makePrediction} is mainly for internal use.

Object members:
\describe{
\item{predict.type (\code{character(1)})}{Type set in \link{setPredictType}.}
\item{data (\link{data.frame})}{See details.}
\item{threshold (\code{numeric(1)})}{Threshold set in predict function.}
\item{task.desc (\link{TaskDesc})}{Task description object.}
\item{time (\code{numeric(1)})}{Time learner needed to generate predictions.}
\item{error (\code{character(1)})}{Any error messages generated by the learner (default NA_character_).}
}

Internal, do not use!
}
\keyword{internal}