RatioArea {similaRpeak} | R Documentation

## RatioArea class

### Description

An object which is a interface to calculate ratio between the profile area of two profiles.

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

The threshold is the minimum profile area value accepted to calculate the ratio.

### Usage

    RatioArea

### Format

An object of class `R6ClassGenerator` of length 24.

### Value

The `RatioArea$new` function returns a `RatioArea` 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 `RatioArea` object.

`RatioArea$new(profile1, profile2, threshold = 1)`

The threshold is the minimum profile area value accepted to calculate the ratio.

The `RatioArea` 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.

[Package similaRpeak version 1.20.0 Index]