enve.recplot2.windowDepthThreshold: Enveomics: Recruitment Plot (2) Window Depth Threshold

View source: R/recplot2.R

enve.recplot2.windowDepthThresholdR Documentation

Enveomics: Recruitment Plot (2) Window Depth Threshold

Description

Identifies the threshold below which windows should be identified as variable or absent.

Usage

enve.recplot2.windowDepthThreshold(
  rp,
  peak,
  lower.tail = TRUE,
  significance = 0.05
)

Arguments

rp

Recruitment plot, an enve.RecPlot2 object.

peak

Peak, an enve.RecPlot2.Peak object. If list, it is assumed to be a list of enve.RecPlot2.Peak objects, in which case the core peak is used (see enve.recplot2.corePeak).

lower.tail

If FALSE, it returns windows significantly above the peak in sequencing depth.

significance

Significance threshold (alpha) to select windows.

Value

Returns a float. The units are depth if the peaks were estimated in linear scale, or log-depth otherwise (peak$log).

Author(s)

Luis M. Rodriguez-R [aut, cre]


enveomics.R documentation built on April 13, 2022, 5:10 p.m.