validateLoadConvergenceData: Validation of some parameters of the 'loadConvergenceData'...

In adeschen/methylInheritance: Permutation-Based Analysis associating Conserved Differentially Methylated Elements Across Multiple Generations to a Treatment Effect

Description

Validation of some parameters needed by the public loadConvergenceData function.

Usage

validateLoadConvergenceData(
  analysisResultsDir,
  permutationResultsDir,
  position,
  by
)

Arguments

analysisResultsDir	a character string, the path to the directory that contains the analysis results. The path can be the same as for the permutatioNResultsDir parameter.
permutationResultsDir	a character string, the path to the directory that contains the permutation results. The path can be the same as for the analysisResultsDir parameter.
position	a positive integer, the position in the list where the information will be extracted.
by	a integer, the increment of the number of permutations where the significant level is tested. Default: 100.

Value

0 indicating that all parameters validations have been successful.

Author(s)

Astrid Deschenes, Pascal Belleau

Examples

## Get the name of the directory where files are stored
filesDir <- system.file("extdata", "TEST", package="methylInheritance")

## Merge permutation and observation results
methylInheritance:::validateLoadConvergenceData(analysisResultsDir =
    filesDir, permutationResults = filesDir, position = 1, by = 1)

## The function raises an error when at least one paramater is not valid
## Not run: methylInheritance:::validateLoadConvergenceData(
    analysisResultsDir = filesDir, permutationResults = filesDir,
    position = "hello", by = 1))
## End(Not run)

adeschen/methylInheritance documentation built on April 21, 2021, 9:45 a.m.