readRecords: Reads Tomahawk output records into memory

In mklarqvist/rtomahawk: Tools for computing, querying and storing linkage-disequilibrium data

Description

Some additional details about this S4 generic and its methods. The extra blank line between this section and the title is critical for roxygen2 to differentiate the title from the description section.

Usage

readRecords(x = "twk", intervals = "ANY", filters = "ANY",
  really = "logical", ...)

Arguments

x	Input Tomahawk class.
intervals	Filter the records using the provided intervals. The intervals can be in either character form or as a GenomicRanges object.
filters	Filter the records using this twk_filter class. This parameter can be set to null to skip all filtering procedures and read all records as is.
really	Logical flag to prevent plotting too many points. Set this to TRUE at your own peril.

Author(s)

Marcus D. R. Klarqvist <[e-mail]> | <https://mdrk.me>

See Also

twk_data, twk_header, twk_filter, and twk

Examples

# This example assumes you have a Tomahawk file called "1kgp3_chr6.two" in
# your current working directory.
f<-setFilters(minR2=0.5)
twk<-openTomahawkOutput("1kgp3_chr6.two")
y<-readRecords(twk,"6:5e6-10e6",f,really=TRUE)
y
# Example using GenomicRanges class.
require(GenomicRanges)
g <- GRanges("6", IRanges(6e6, 7e6))
y<-readRecords(twk,g,f,really=TRUE)
y

mklarqvist/rtomahawk documentation built on May 16, 2019, 5:01 a.m.