write.PI: write parts of a timeseriesset into PI format

In delftfews: delftfews R extensions

Description

use this function to produce a PI file.

each column of the data that has a describing row in data.description will be output to the output.file.

you can specify global.data that will be added to each and every series.event element in the output.

each row of the 'data.description' data.frame describes a series. the 'column' field is matched with a column in data'. other necessary columns are: type, locationId, parameterId, timeStep, startDate and endDate. optional columns are missVal, longName, stationName, units.

missVal specifies the way NA (missing) values must be handled. - NULL: skips the element. - NA: set the value to 0 and flag it as missing. - numeric: set the value to this missVal.

Usage

write.PI(data, data.description, filename, global.data)

Arguments

data	the timeseries-set. either a data.frame with the column 'timestamps' or a zoo object.
data.description	a data.frame. each row describes a column in the 'data' that goes in the PI file.
filename	the name of the output xml file
global.data	an optional data.frame containing one row, each field describes one element, to be added to the header of all series.

Examples

pidata <- timeseries(from=0, to=86400, by=3600)
## Not run: pidata <- read.PI('data/decumulative.input.NA.xml', na.action=na.pass)
  conf <- data.frame(column=c('P1201', 'P1202', 'P1203'))
  conf$type <- 'instantaneous'
  conf$locationId <- c('600-P1201', '600-P1202', '600-P1203')
  conf$parameterId <- 'parameterId'
  conf$units <- '-'
  conf$missVal <- -999
  conf$stationName <- '-'
  conf$longName <- '-'

  result <- timeseries(order.by=index(pidata)[-1], P1201=NA, P1202=NA, P1203=NA)
  
  ## Not run: write.PI(result, conf, 'data/test.write.PI.na.4.xml.current')

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