read_bs_bismark_cov: Read Bismark Cov formatted BS-Seq file

Description Usage Arguments Value Important Author(s) References See Also Examples

Description

read_bs_bismark_cov reads a file containing methylation data from BS-Seq experiments using the fread function. The BS-Seq file should be in Bismark Cov format. Read the Important section below on when to use this function.

Usage

1
read_bs_bismark_cov(file, chr_discarded = NULL, is_GRanges = TRUE)

Arguments

file

The name of the file to read data values from.

chr_discarded

A vector with chromosome names to be discarded.

is_GRanges

Logical: if TRUE a GRanges object is returned, otherwise a data.frame object is returned.

Value

A GRanges object if is_GRanges is TRUE, otherwise a data.table object.

The GRanges object contains two additional metadata columns:

These columns can be accessed as follows: granges_object$total_reads

Important

Unless you want to create a different workflow when processing the BS-Seq data, you should NOT call this function, since this is a helper function. Instead you should call the preprocess_bs_seq function.

Author(s)

C.A.Kapourani C.A.Kapourani@ed.ac.uk

References

http://rnbeads.mpi-inf.mpg.de/data/RnBeads.pdf

See Also

pool_bs_seq_rep, preprocess_bs_seq

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
# Download the files and change the working directory to that location
file <- "name_of_bismark_file"
bs_data <- read_bs_bismark_cov(file)

# Extract the total reads and methylated reads
total_reads <- bs_data$total_reads
meth_reads <- bs_data$meth_reads

## End(Not run)

andreaskapou/BPRMeth-devel documentation built on May 12, 2019, 3:32 a.m.