File: TaskDesc.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 (38 lines) | stat: -rw-r--r-- 2,096 bytes parent folder | download | duplicates (4)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/TaskDesc.R
\name{TaskDesc}
\alias{TaskDesc}
\title{Description object for task.}
\description{
Description object for task, encapsulates basic properties of the task
without having to store the complete data set.
}
\details{
Object members:
\describe{
\item{id (\code{character(1)})}{Id string of task.}
\item{type (\code{character(1)})}{Type of task, \dQuote{classif} for classification,
\dQuote{regr} for regression, \dQuote{surv} for survival and \dQuote{cluster} for
cluster analysis, \dQuote{costsens} for cost-sensitive classification, and
\dQuote{multilabel} for multilabel classification.}
\item{target (\code{character(0)} | \code{character(1)} | \code{character(2)} | \code{character(n.classes)})}{
Name(s) of the target variable(s).
For \dQuote{surv} these are the names of the survival time and event columns, so it has length 2.
For \dQuote{costsens} it has length 0, as there is no target column, but a cost matrix instead.
For \dQuote{multilabel} these are the names of logical columns that indicate whether a
class label is present and the number of target variables corresponds to the number of
classes.}
\item{size (\code{integer(1)})}{Number of cases in data set.}
\item{n.feat (\code{integer(2)})}{Number of features, named vector with entries:
\dQuote{numerics}, \dQuote{factors}, \dQuote{ordered}, \dQuote{functionals}.}
\item{has.missings (\code{logical(1)})}{Are missing values present?}
\item{has.weights (\code{logical(1)})}{Are weights specified for each observation?}
\item{has.blocking (\code{logical(1)})}{Is a blocking factor for cases available in the task?}
\item{class.levels (\link{character})}{All possible classes.
Only present for \dQuote{classif}, \dQuote{costsens}, and \dQuote{multilabel}.}
\item{positive (\code{character(1)})}{Positive class label for binary classification.
Only present for \dQuote{classif}, NA for multiclass.}
\item{negative (\code{character(1)})}{Negative class label for binary classification.
Only present for \dQuote{classif}, NA for multiclass.}
}
}