aggregate: Aggregate billions of data points into a...

Description Usage Arguments Value Author(s) See Also Examples

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

1
2
3
4
aggregate(x = "twk", aggregation = "character",
  reduction = "character", xbins = "numeric", ybins = "numeric",
  minCount = "numeric", threads = "numeric", verbose = "logical",
  progress = "logical", ...)

Arguments

x

Input twk class holding the target path.

aggregation

String representing the aggregation function to use on the input data.

reduction

String representing the reduction function to use after after data has been aggregated.

xbins

Number of bins (pixels) in the x-dimension.

ybins

Number of bins (pixels) in the y-dimension.

minCount

Only pixels with at least this many observations are reported.

threads

Number of aggregation/reduction threads to use.

verbose

Flag triggering verbose output (written to std::cerr). This will usually, but not always, be appropriately handled by R.

progress

This flag will trigger a detached thread internal to Tomahawk that will tick progression every 30 seconds to the console. Note that R NEVER cleans up this thread and it will tick until the R instance is closed.

Value

Returns a twk_agg object with the aggregated matrix.

Author(s)

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

See Also

twk_data, twk_header, twk_filter, and twk

Examples

1
2
3
4
5
6
# Assuming you have a file called "test.two" in your downloads directory.
twk<-openTomahawkOutput("~/Downloads/test.two")
agg <- aggregateOutput(twk, "r2" ,"count", 1000, 1000, 50, verbose = T, threads = 4)
plot(agg, normalize = TRUE)
plot(agg, normalize = FALSE)
agg

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