validateSegmentationParameters {RJMCMCNucleosomes} | R Documentation |
segmentation
functionValidation of all parameters needed by the public
segmentation
function.
validateSegmentationParameters(reads, zeta = 147, delta, maxLength)
reads |
a |
zeta |
a positive |
delta |
a positive |
maxLength |
a positive |
0
indicating that all parameters validations have been
successful.
Astrid Deschenes, Pascal Belleau
## Load synthetic dataset of reads data(syntheticNucleosomeReads) ## Use dataset of reads to create GRanges object sampleGRanges <- GRanges(seqnames = syntheticNucleosomeReads$dataIP$chr, ranges = IRanges(start = syntheticNucleosomeReads$dataIP$start, end = syntheticNucleosomeReads$dataIP$end), strand = syntheticNucleosomeReads$dataIP$strand) ## The function returns 0 when all parameters are valid RJMCMCNucleosomes:::validateSegmentationParameters(reads = sampleGRanges, zeta = 147, delta = 30, maxLength = 12000) ## The function raises an error when at least one paramater is not valid #\dontrun{RJMCMCNucleosomes:::validateSegmentationParameters( #reads = c(100), zeta = 147, delta = 30, maxLength = 12000)} #\dontrun{RJMCMCNucleosomes:::validateSegmentationParameters( #reads = sampleGRanges, zeta = "hi", delta = 30, maxLength = 12000)}