Metric: Metric class

In similaRpeak: Metrics to estimate a level of similarity between two ChIP-Seq profiles

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

Metric

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:

• getMetric A function that returns the value of the calculated metric

• getInfo A function that returns a description of the metric with the metric value.

• getType A function that returns the unique name associated to this metric

• calculateMetric A function that modifies the values of the two profiles and the threshold. The new values (profile1, profile2, threshold) are passed as arguments.

Author(s)

Astrid Deschenes

See Also

• MetricFactory for using the recommanded interface to calculate all available metrics separately or togheter.

similaRpeak documentation built on Nov. 8, 2020, 6:56 p.m.