validatecalculateLog2ratioMetricParameters: Parameters validation for the 'calculateLog2ratioMetric'...

In KrasnitzLab/CNVMetrics: Copy Number Variant Metrics

Parameters validation for the calculateLog2ratioMetric function

Description

Validation of all parameters needed by the public calculateLog2ratioMetric function.

Usage

validatecalculateLog2ratioMetricParameters(
  minThreshold,
  excludedRegions,
  nJobs
)

Arguments

minThreshold	a single positive numeric setting the minimum value to consider two segments as different during the metric calculation. If the absolute difference is below or equal to threshold, the difference will be replaced by zero.
excludedRegions	an optional GRanges containing the regions that have to be excluded for the metric calculation or NULL.
nJobs	a single positive integer specifying the number of worker jobs to create in case of distributed computation.

Value

0.

Author(s)

Astrid Deschênes

Examples

## Return zero as all parameters are valid
CNVMetrics:::validatecalculateLog2ratioMetricParameters(
    minThreshold=0.9, excludedRegions=NULL, nJobs=1)

KrasnitzLab/CNVMetrics documentation built on July 30, 2023, 2:22 p.m.