syntheticNucReadsValidation: Subsection of parameter validation for identical parameters...

Description Usage Arguments Value Author(s) Examples

View source: R/nucleoSimInternFunctions.R

Description

Validate that identical values passed to both syntheticNucReadsFromMap and syntheticNucReadsFromDist functions are correctly formatted.

Usage

1

Arguments

read.len

a positive integer, the length of each of the paired-end reads.

offset

a non-negative integer, the number of bases used to offset all nucleosomes and reads. This is done to ensure that all nucleosome positions and read alignment are of positive values.

Value

0 indicating that all parameters validations have been successful.

Author(s)

Astrid Deschenes

Examples

1
2
3
4
5
6
## The function returns 0 when all paramaters are valid
nucleoSim:::syntheticNucReadsValidation(read.len = 40, offset = 100)

## The function raises an error when at least one paramater is not valid
## Not run: nucleoSim:::syntheticNucReadsValidation(read.len = 0, offset = 100)
## Not run: nucleoSim:::syntheticNucReadsValidation(read.len = 30, offset = -1)

nucleoSim documentation built on May 6, 2019, 2:17 a.m.