DTSg: alter.DTSg – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

alter.DTSg

Alter Time Series

Description

Shortens, lengthens, filters for a consecutive range, changes the periodicity and/or the status of missing values of a DTSg object.

Usage

## S3 method for class 'DTSg'
alter(
  x,
  from = first(self$values(reference = TRUE)[[".dateTime"]]),
  to = last(self$values(reference = TRUE)[[".dateTime"]]),
  by = self$periodicity,
  rollback = TRUE,
  clone = getOption("DTSgClone"),
  na.status = self$na.status,
  ...
)

Arguments

`x`	A `DTSg` object (S3 method only).
`from`	A `POSIXct` date with the same time zone as the time series or a character string coercible to one. Specifies the new start of the time series.
`to`	A `POSIXct` date with the same time zone as the time series or a character string coercible to one. Specifies the new end of the time series.
`by`	Specifies the new periodicity in one of the ways the `by` argument of `seq.POSIXt` can be specified. Must be specified for time series with unrecognised periodicity. Time steps out of sync with the new periodicity are dropped.
`rollback`	A logical specifying if a call to `rollback` is made when appropriate.
`clone`	A logical specifying if the object is modified in place or if a clone (copy) is made beforehand.
`na.status`	A character string. Either `"explicit"`, which makes missing timestamps according to the recognised periodicity explicit, or `"implicit"`, which removes timestamps with missing values on all value columns. Please note that `DTSg` objects work best with explicit missing values.
`...`	Not used (S3 method only).

Value

Returns a DTSg object.

Examples

# new DTSg object
x <- DTSg$new(values = flow)

# filter for the first two years
## R6 method
x$alter(from = "2007-01-01", to = "2008-12-31")

## S3 method
alter(x = x, from = "2007-01-01", to = "2008-12-31")

# change periodicity to one month
## R6 method
x$alter(by = "1 month")

## S3 method
alter(x = x, by = "1 month")

DTSg

A Class for Working with Time Series Based on 'data.table' and 'R6' with Largely Optional Reference Semantics

v0.7.0

MIT + file LICENSE

Authors

Gerold Hepp [aut, cre]

Initial release