readInterGenerationResults {methylInheritance} | R Documentation

## Read and return intergenerational results contained in a RDS file

### Description

Read and return intergenerational results contained in a RDS file

### Usage

    readInterGenerationResults(
      outputDir,
      permutationID,
      type = c("sites", "tiles")
    )

### Arguments

`outputDir` | a string of `character`, the name of the directory that will contain the results of the permutation. The name should end with a slash. The directory should already exists.
`permutationID` | an `integer`, the identifiant of the permutation. When the `permutationID` = `0`, the results are considered as the observed results and are saved in a file with the "_observed_results.RDS" extension. When the `permutationID` != `0`, the results are considered as permutation results and are saved in a file with the "_permutation_permutationID.RDS" extension.
`type` | One of the `"sites"` or `"tiles"` strings. Specifies the type of differentially methylated elements should be saved. Default: `"sites"`.

### Value

a `list` containing the intergenerational results for the specified permutation.

### Author(s)

Astrid Deschenes, Pascal Belleau

### Examples

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

    ## Read DMS intergenerational results for the observed data
    methylInheritance:::readInterGenerationResults(outputDir =
        paste0(filesDir, "/"), 0, "sites")

[Package methylInheritance version 1.18.0 Index]