Metric: Metric class

Description Usage Format Value Constructor Author(s) See Also

Description

A class which represents a abstract Metric object which is used to quantify the similarity between two profiles covering the same range.

The Metric class should not be directly instanciated. It should be used as the parent class of a specific metric class.

Usage

1

Format

An object of class R6ClassGenerator of length 24.

Value

The Metric$new function returns a Metric object which contains the information about the two profiles and the threshold used to calculate the metric. It can be used, as many times needed, to calculate the specified metric.

Constructor

Create a Metric object.

Metric$new(profile1, profile2, threshold = NULL)

The Metric object inherites those functions:

Author(s)

Astrid Deschenes

See Also


similaRpeak documentation built on Nov. 1, 2018, 3:46 a.m.