#' @title Query properties of measures.
#'
#' @description
#' Properties can be accessed with \code{getMeasureProperties(measure)}, which returns a
#' character vector.
#'
#' The measure properties are defined in \code{\link{Measure}}.
#' @template arg_measure
#' @param props [\code{character}]\cr
#' Vector of properties to query.
#' @return \code{getMeasureProperties} returns a character vector with measure properties.
#' \code{hasMeasureProperties} returns a logical vector of the same length as \code{props}.
#' @name MeasureProperties
#' @rdname MeasureProperties
#' @aliases getMeasureProperties hasMeasureProperties
NULL
#' @rdname MeasureProperties
#' @export
getMeasureProperties = function(measure) {
assertClass(measure, classes = "Measure")
measure$properties
}
#' @rdname MeasureProperties
#' @export
hasMeasureProperties = function(measure, props) {
assertClass(measure, classes = "Measure")
assertSubset(props, listMeasureProperties())
props %in% getMeasureProperties(measure)
}
#' @title List the supported measure properties.
#'
#' @description
#' This is useful for determining which measure properties are available.
#'
#' @return [\code{character}].
#'
#' @export
listMeasureProperties = function() {
mlr$measure.properties
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.