read.PI: read PI file as data.frame

Description Usage Arguments Examples

View source: R/timeseries-io.R

Description

reads a PI file, check the most common time step, force the data into a data.frame.

the input PI file may define a non zero 'timeZone'. this is acknowledged and the date/time instants in the 'timestamps' column will appear to you as shifted: keep in mind that a time instant is independent of the time zone concept: only its string representation is affected. the standard 'format' function, will help you see the data in the same form as in the input, just specify the correct 'tz'.

the time series set read in the PI file is forced into a set of equally spaced time series. the step chosen will be the most common step in the PI file. there is no guarantee that this is what you really need nor meant.

Usage

1
2
3
read.PI(filename, step.seconds = NA, na.action = na.fill, parameterId,
        is.irregular = FALSE, filter.timestamp, skip.short.lived = NA,
        base)

Arguments

filename

the name of the xml file containing the timeseries

step.seconds

the timestep in the timeseries. it is inferred from the data if left unspecified

na.action

what has to happen to NA values. can be any function that operates on the NA values of a vector, as for example 'na.pass' or 'na.zero'. defaults to 'na.fill'.

parameterId

character: if specified, indicates that we are interested in one parameter, not the whole file.

is.irregular

logic: if TRUE, indicates that the resulting time series set is not regularly spaced.

filter.timestamp

logic function: if specified, it is used to decide whether an event has to be memorized.

skip.short.lived

numeric: if available, indicates the required lifespan for a value. all values lasting shorter than this are considered invalid and overwritten by the first following value.

base

numeric: in seconds since 1970-01-01, the base for the timestamps of the resulting zoo object. otherwise inferred from the data.

Examples

1
2
3
4
5
## Not run: pidata <- read.PI('pi.xml', step.seconds=900)

## Not run: pidata <- read.PI('pi.xml')

## Not run: pidata <- read.PI('pi.xml', na.action=na.pass)

delftfews documentation built on May 2, 2019, 4:48 p.m.