IsReg_ts: Wrapper function for function 'is.regular' from 'zoo' package...

Description Usage Arguments Details Value Author(s) Examples

Description

"IsReg.ts" is a wrapping Function for Function "is.regular" from "zoo" package. Given a time series (ts) a "data.frame" object it is converted into a "xts" object, while the regularity of the object is checked. The first column of the "data.frame" should contain a character string vector to be converted via as.POSIXct accordingly with the date format (format) and time zone (tz).

Usage

1

Arguments

data

an object of class data.frame containing in its first column a character string vector to be converted via as.POSIXct into a date vector accordingly with the date format (format) and time zone (tz) defined

format

character string giving a date-time format as used by strptime.

tz

a time zone specification to be used for the conversion, if one is required. System-specific, but "" is the current time zone, and "GMT" is UTC (Universal Time, Coordinated). Invalid values are most commonly treated as UTC, on some platforms with a warning.

Details

"IsReg" calls the as.POSIXct function from base package to convert an object to one of the two classes used to represent date/times (calendar dates plus time to the nearest second). More details can be found in the "is.regular" function of the "zoo" package.

Value

Object of class "list". This object contains 2 elements, the first one contains a character string "_TSregular" if the xts object created is strict regular, or "_TSirregular" if it is strict irregular. More details can be found in the "is.regular" function of the "zoo" package.

Author(s)

J.A. Torres-Matallana

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
library(EmiStatR)
data("P1")

class(P1)
head(P1)

ts <- IsReg.ts(data = P1, format = "%Y-%m-%d %H:%M:%S", tz = "UTC")
str(ts)

ts[[1]]

head(ts[[2]]); tail(ts[[2]])

plot(ts[[2]], ylab = "Precipitation [mm]")

stUPscales documentation built on May 6, 2019, 1:08 a.m.