validateCalculateOverlapMetricParameters: Parameters validation for the 'calculateOverlapMetric'...

In KrasnitzLab/CNVMetrics: Copy Number Variant Metrics

Parameters validation for the calculateOverlapMetric function

Description

Validation of all parameters needed by the public calculateOverlapMetric function.

Usage

validateCalculateOverlapMetricParameters(states, nJobs)

Arguments

states	a vector of character string with at least one entry. The strings are representing the states that will be analyzed.
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:::validateCalculateOverlapMetricParameters(
    states="GAIN", nJobs=1)

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