ratioMaxMaxMethod: Ratio of profiles maximal peaks between two profiles

View source: R/metricsMethods.R

ratioMaxMaxMethodR Documentation

Ratio of profiles maximal peaks between two profiles

Description

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

Usage

ratioMaxMaxMethod(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 peak value accepted to calculate a ratio.

Value

The calculated ratio or NA if one peak 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.