AdaptixForecast: Perform forecast.

In Sensewaves/AdaptixR: A toolkit to interact with Sensewaves' Adaptix platform API

Description

Perform forecast.

Usage

AdaptixForecast(conn, stream, from = NULL, to = NULL, span = NULL,
  history = NULL, aggregated = FALSE, individual = TRUE,
  number.of.scenarios = 0, rate = NULL, verbose = FALSE)

Arguments

conn	a valid Adaptix connection object.
stream	the ID of the stream on which to perform the forecast.
from	if not NULL, the starting date of the forecast. If NULL, defaults to the last point of the stream.
to	if not NULL, the closing date of the forecast. required if span is NULL.
span	a "span string" describing the forecast horizon. required if to is NULL.
aggregated	if TRUE, the forecast will be provided as an aggregated forecast scenario, along with confidence margins.
individual	if TRUE, the forecast will be provided as multiple plausible
number.of.scenarios	if individual parameter is TRUE, restricts the number of scenarios that can be provided. If equal to 0, all scenarios deemed plausible by Adaptix will be provided.
rate	desired frame rate of the forecast scnearios. Currently under development.
verbose	display HTTP operation details.
window	a "span string" describing a constraint on the data history to consider in the forecast.

Value

a data.frame with the requested collection of points.

Examples

AdaptixForecast(conn = conn, stream = "123456abcdef", from = "2017-01-01", to = "2017-01-02", individual = T, number.of.scenarios = 3, verbose = F)

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