Revision 768a94f53fa2e087592fd71d3b7566d0b3776540 authored by pat-s on 15 March 2020, 21:25:27 UTC, committed by pat-s on 15 March 2020, 21:25:27 UTC
1 parent 527ab33
Raw File
listMeasures.Rd
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/listMeasures.R
\name{listMeasures}
\alias{listMeasures}
\alias{listMeasures.default}
\alias{listMeasures.character}
\alias{listMeasures.Task}
\title{Find matching measures.}
\usage{
listMeasures(obj, properties = character(0L), create = FALSE)

\method{listMeasures}{default}(obj, properties = character(0L), create = FALSE)

\method{listMeasures}{character}(obj, properties = character(0L), create = FALSE)

\method{listMeasures}{Task}(obj, properties = character(0L), create = FALSE)
}
\arguments{
\item{obj}{(\code{character(1)} | \link{Task})\cr
Either \code{character(1)} task or the type of the task, in the latter case one of:
\dQuote{classif} \dQuote{regr} \dQuote{surv} \dQuote{costsens} \dQuote{cluster} \dQuote{multilabel}.
Default is \code{NA} matching all types.}

\item{properties}{(\link{character})\cr
Set of required properties to filter for.
See \link{Measure} for some standardized properties.
Default is \code{character(0)}.}

\item{create}{(\code{logical(1)})\cr
Instantiate objects (or return strings)?
Default is \code{FALSE}.}
}
\value{
([character\code{|}list` of \link{Measure}). Class names of matching
measures or instantiated objects.
}
\description{
Returns the matching measures which have specific characteristics, e.g.
whether they supports classification or regression.
}
back to top