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

View source: R/CNVMetricsInternalMethods.R

validateCalculateOverlapMetricParametersR Documentation

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)


adeschen/CNVMetrics documentation built on July 19, 2023, 10:24 p.m.