twk_agg-class: Tomahawk output aggregation class

Description Slots Author(s) See Also

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.

Slots

twk

Instance of a twk object. This is the computed information that is returned from the underlying .Call to Tomahawk. Note that no data is stored in this object in this case.

n

Total number of data points in the reduced output matrix.

x

Number of bins in the X dimension.

y

Number of bins in the Y dimension.

bpx

Base-pairs encompassed in each x-bin.

bpy

Base-pairs encompassed in each y-bin.

aggregation

The function string name used for aggregation.

reduction

The function string name used for reduction.

n_original

Total number of original data points prior to aggregation.

range

Total number of base-pairs encompassed by the aggregator.

offsets

Data frame representing the cumulative number of base-pairs used by each chromosome in the file.

data

Output aggregated matrix of size [x, y] such that x*y = n.

Author(s)

Marcus D. R. Klarqvist <mk819@cam.ac.uk> | <https://mdrk.me>

See Also

twk_index, twk_header, twk_filter, and twk


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