runPipeline: runPipeline

Description Usage Arguments Value Examples

Description

This function is the means of accessing quality control functions of the MethyLiution package. Most procedures are invoked in a set order due to requirements for output from previous steps, so a single function invoking those procedures as a fixed workflow is preferable.
Analysis is broken down into a pipeline of 10 steps:

For more details, see vignette(MethyLiution).

Usage

1
2
3
4
runPipeline(datadir, metafile, outdir, array = "450K", max_pval = 0.05,
  max_prop = 0.5, max_plot = 30, threads = 1,
  gender_stringent = FALSE, normalisation_method = "quantile",
  begin = 1, end = 9)

Arguments

datadir

Path to directory containing IDAT files

metafile

Path to file containing experimental metadata

outdir

Path to output directory

array

Microarray probeset used: valid options are "450K" and "EPIC" (default "450K")

max_pval

Upper threshold for considering a result significant (default 0.05)

max_prop

For each probe, the freq/proportion of assays that fail by max_pval of detection (default 0.5)

max_plot

Maximum number of plot output files to create (default 30)

threads

Number of threads to run certain tasks in parallel (default 1)

gender_stringent

Should the pipeline discard samples where inferred gender is inconsistent with metadata? (default FALSE)

normalisation_method

Normalisation method: one of 'quantile', 'ssn', or 'none'. (default 'quantile')

begin

Step the pipeline begins at (default 1)

end

Step the pipeline ends at (default 9)

Value

path to output directory

Examples

1

NeilPearson-Lilly/MethyLiution documentation built on May 21, 2019, 11:29 a.m.