TP: Computes the True Positive Value.

TPR Documentation

Computes the True Positive Value.

Description

TP is the number of individuals with a positive condition for which the test result is positive. The value entered here must be non-negative.

Super class

D2MCS::MeasureFunction -> TP

Methods

Public methods


Method new()

Method for initializing the object arguments during runtime.

Usage
TP$new(performance.output = NULL)
Arguments
performance.output

An optional ConfMatrix parameter to define the type of object used to compute the measure.


Method compute()

The function computes the TP achieved by the M.L. model.

Usage
TP$compute(performance.output = NULL)
Arguments
performance.output

An optional ConfMatrix parameter to define the type of object used as basis to compute the TP measure.

Details

This function is automatically invoke by the ClassificationOutput object.

Returns

A numeric vector of size 1 or NULL if an error occurred.


Method clone()

The objects of this class are cloneable with this method.

Usage
TP$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

MeasureFunction, ClassificationOutput, ConfMatrix


D2MCS documentation built on Aug. 23, 2022, 5:07 p.m.