sortbynz: Sort by NZ

View source: R/sortbynz.r

sortbynzR Documentation

Sort by NZ

Description

Sort an xts object by its header values (e.g. NZ)

Usage

sortbynz(
  x,
  writefile = NULL,
  returnmatrix = TRUE,
  tz = "utc",
  dls.remove = TRUE,
  ...
)

Arguments

x

xts object or character string to a file that will be read using read.xts.

writefile

NULL or character string pointing to a file, that will be written.

returnmatrix

logical. Should the result be returned to R?

tz

character. Time zone.

dls.remove

logical. Should daylight savings be removed from the time series using rm.dls

...

additional parameters passed on to read.xts

Details

This function was designed to sort an xts object created by make.COSERO.input. It can read the xts object from file or it may be fed with one directly. If x an xts object, it must contain col.names with the nz information.

Value

An xts object, if returnmatrix == TRUE

Author(s)

Simon Frey

See Also

make.COSERO.input; read.xts

read.xts, rm.dls


freysimon/ZAMGR documentation built on Nov. 3, 2023, 9:44 p.m.