ratioAreaMethod: Ratio of profiles area between two profiles

View source: R/metricsMethods.R

ratioAreaMethodR Documentation

Ratio of profiles area between two profiles

Description

Calculate and return the ratio of profiles area between two profiles covering the same range. The area of the first profile is always divided by the area of the second profile.If one area value is inferior to the threshold, the function returns NA.

Usage

ratioAreaMethod(profile1, profile2, threshold = 1)

Arguments

profile1

a vector of numeric values, the first profile containing the alignment depth for each position. The profile1 and profile2 should have the same length.

profile2

a vector of numeric values, the second profile containing the alignment depth for each position. The profile1 and profile2 should have the same length.

threshold

a numeric, the minimum profile area value accepted to calculate a ratio.

Value

The calculated ratio or NA if one profile area value is inferior to the threshold.

Author(s)

Astrid Deschenes, Elsa Bernatchez

See Also

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


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