RatioNormalizedIntersect: RatioNormalizedIntersect class

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

RatioNormalizedIntersect class

Description

An object which is a interface to calculate the ratio of profiles intersection area between two normalized profiles.The profiles are

The RatioNormalizedIntersect object is needed to calculate the ratio of profiles intersection area between two normalized profiles. A threshold and the two profiles are set during the RatioNormalizedIntersect object creation. If different profiles are needed, the calculateMetric function should be used, with the new profiles passed as arguments to update those values inside the RatioNormalizedIntersect object.

The threshold is the minimum total normalized area value accepted to calculate a ratio.

Usage

RatioNormalizedIntersect

Format

An object of class R6ClassGenerator of length 24.

Value

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

Constructor

Create a RatioNormalizedIntersect object.

RatioNormalizedIntersect$new(profile1, profile2, threshold = 1)

The threshold is the minimum total normalized area value accepted to calculate a ratio. Default = 1

The RatioNormalizedIntersect 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 a interface to calculate all available metrics separately or togheter.

adeschen/similaRpeak documentation built on March 23, 2022, 11:10 a.m.