validateMergePermutationAndObservation {methylInheritance} | R Documentation

## Validation of some parameters of the `mergePermutationAndObservation` function

### Description

Validation of some parameters needed by the public `mergePermutationAndObservation` function.

### Usage

    validateMergePermutationAndObservation(permutationResults, observationResults)

### Arguments

`permutationResults` | a `list` with 1 entry called `PERMUTATION`. The `PERMUTATION` entry is a `list` with a number of entries corresponding to the number of permutations that have been processed. Each entry contains the result of one permutation.
`observationResults` | a `list` with 1 entry called `OBSERVATION`. The `OBSERVATION` entry is a `list` containing the result obtained with the observed dataset (not shuffled).

### Value

`0` indicating that all parameters validations have been successful.

### Author(s)

Astrid Deschenes

### Examples

    ## Create a observation result
    observed <- list()
    observed[["OBSERVATION"]] <- list()
    observed[["OBSERVATION"]][["SITES"]] <- list()
    observed[["OBSERVATION"]][["SITES"]][["i2"]] <- list(HYPER = list(11, 10),
        HYPO = list(13, 12))
    observed[["OBSERVATION"]][["SITES"]][["iAll"]] <- list(HYPER = list(1),
        HYPO = list(3))

    ## Create a permutation result containing only 1 permutation result
    ## Real perumtations results would have more entries
    permutated <- list()
    permutated[["PERMUTATION"]] <- list()
    permutated[["PERMUTATION"]][[1]] <- list()
    permutated[["PERMUTATION"]][[1]][["SITES"]] <- list()
    permutated[["PERMUTATION"]][[1]][["SITES"]][["i2"]] <- list(HYPER =
        list(11, 12), HYPO = list(8, 11))
    permutated[["PERMUTATION"]][[1]][["SITES"]][["iAll"]] <- list(HYPER =
        list(0), HYPO = list(1))

    ## Merge permutation and observation results
    methylInheritance:::validateMergePermutationAndObservation(
        permutationResults = permutated, observationResults = observed)

    ## The function raises an error when at least one paramater is not valid
    ## Not run: methylInheritance:::validateMergePermutationAndObservation(
        permutationResults = permutated, observationResults = NULL)
    ## End(Not run)

[Package methylInheritance version 1.18.0 Index]