AdaptixGetPoints: Collects the points of an Adaptix stream.

Description Usage Arguments Value Examples

Description

Collects the points of an Adaptix stream.

Usage

1
2
AdaptixGetPoints(conn, stream, from = NULL, to = NULL, groupby = NULL,
  aggregator = NULL, fill = NULL, verbose = FALSE)

Arguments

conn

a valid Adaptix connection object.

stream

the ID of the stream from which to retrieve the points.

from

if not NULL, the starting date of the time window.

to

if not NULL, the closing date of the time window.

aggregator

if NULL, the type of aggregation that will be processed over the aggregation windows (group.by parameter) - see Adaptix API documentation for details.

fill

if NULL, missing data in the stream points will be filled according to the supplied supported operator

verbose

display HTTP operation details.

group.by

if NULL, the raw points will be retrieved. If supplied as a "span" string describing a time window, the points will be retrieved as an aggregation (MEAN by default, for other options see aggregator parameter) over consecutive windows of the specified length - see Adaptix API documentation.

Value

a data.frame with the requested collection of points.

Examples

1
AdaptixGetPoints(conn = conn, stream = "123456abcdef", group.by = "1h", aggregator = "MEAN", verbose = F)

Sensewaves/AdaptixR documentation built on May 28, 2019, 2:44 p.m.