custom_stat_aggregator: Aggregation which returns arbitrary statistics

In shinyHugePlot: Efficient Plotting of Large-Sized Data

Aggregation which returns arbitrary statistics

Description

This aggregator divides the data into no-overlapping intervals and calculate specific statistical values such as the mean.

Format

An R6::R6Class object

Super class

shinyHugePlot::aggregator -> custom_stat_aggregator

Methods

Public methods

• custom_stat_aggregator$new()

• custom_stat_aggregator$clone()

Inherited methods

• shinyHugePlot::aggregator$aggregate()
• shinyHugePlot::aggregator$set_parameters()

---

Method new()

Constructor of the Aggregator.

Constructor of the Aggregator.

Usage

custom_stat_aggregator$new(
  ...,
  y_func = mean,
  x_mean = TRUE,
  interleave_gaps,
  coef_gap,
  NA_position
)

Arguments

y_func

Function. Statistical values are calculated using this function. By default, mean.

x_mean

Boolean. Whether using the mean values or not for the x values. If not, the x values that give the specific y values are used. E.g., if you use max as the aggregation_func and set this argument to FALSE, x values that give the maximum y values are used. By default, TRUE.

interleave_gaps, coef_gap, NA_position, ...

Arguments pass to the constructor of aggregator object.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

custom_stat_aggregator$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

data(noise_fluct)
agg <- custom_stat_aggregator$new(y_func = mean, interleave_gaps = TRUE)
d_agg <- agg$aggregate(noise_fluct$time, noise_fluct$f500, 1000)
plotly::plot_ly(x = d_agg$x, y = d_agg$y, type = "scatter", mode = "lines")

shinyHugePlot documentation built on Oct. 1, 2024, 5:08 p.m.