hydroTSM: daily2monthly – R documentation

Pricing

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

Get Started for Free

Documentation

hydroTSM

daily2monthly

(sub)Daily -> Monthly

Description

Generic function for transforming a DAILY (sub-daily or weekly) regular time series into a MONTHLY one

Usage

daily2monthly(x, ...)
subdaily2monthly(x, ...)

## Default S3 method:
daily2monthly(x, FUN, na.rm = TRUE, ...)

## S3 method for class 'zoo'
daily2monthly(x, FUN, na.rm = TRUE, ...)

## S3 method for class 'data.frame'
daily2monthly(x, FUN, na.rm = TRUE, dates=1, date.fmt = "%Y-%m-%d", 
        out.type = "data.frame", out.fmt="numeric", verbose = TRUE, ...)

## S3 method for class 'matrix'
daily2monthly(x, FUN, na.rm = TRUE, dates=1, date.fmt = "%Y-%m-%d", 
        out.type = "data.frame", out.fmt="numeric", verbose = TRUE, ...)

Arguments

`x`	zoo, xts, data.frame or matrix object, with daily/monthly time series. Measurements at several gauging stations can be stored in a data.frame or matrix object, and in that case, each column of `x` represent the time series measured in each gauging station, and the column names of `x` have to correspond to the ID of each station (starting by a letter).
`FUN`	Function that have to be applied for transforming from daily to annual time step. (e.g., for precipitation `FUN=sum` and for temperature and streamflow ts, `FUN=mean`).
`na.rm`	Logical. Should missing values be removed? -) `TRUE` : the monthly and annual values are computed considering only those values different from NA -) `FALSE`: if there is AT LEAST one NA within a year, the monthly values are NA
`dates`	numeric, factor or Date object indicating how to obtain the dates for each gauging station If `dates` is a number (default), it indicates the index of the column in `x` that stores the dates If `dates` is a factor, it is converted into Date class, using the date format specified by `date.fmt` If `dates` is already of Date class, the code verifies that the number of days on it be equal to the number of elements in `x`
`date.fmt`	character indicating the format in which the dates are stored in `dates`, e.g. `%Y-%m-%d`. See `format` in `as.Date`. ONLY required when `class(dates)=="factor"` or `class(dates)=="numeric"`.
`out.type`	Character that defines the desired type of output. Valid values are: -) `data.frame`: a data.frame, with as many columns as stations are included in `x`, and row names indicating the month and year for each value. -) `db` : a data.frame, with 4 columns will be produced. The first column (StationID) stores the ID of the station, The second column (Year) stores the year The third column (Month) stores the Month The fourth column (Value) stores the numerical values corresponding to the values specified in the three previous columns.
`out.fmt`	OPTIONAL. Only used when `x` is a matrix or data.frame object /cr character, for selecting if the result will be a matrix/data.frame or a zoo object. Valid values are: `numeric`, `zoo`.
`verbose`	logical; if TRUE, progress messages are printed
`...`	further arguments passed to or from other methods.

Author(s)

Mauricio Zambrano-Bigiarini, mzb.devel@gmail

Examples

######################
## Ex1: Loading the DAILY precipitation data at SanMartino
data(SanMartinoPPts)
x <- SanMartinoPPts

## Daily to monthly
m <- daily2monthly(x, FUN=sum, na.rm=TRUE)

######################
## Ex2: Loading the time series of HOURLY streamflows for the station Karamea at Gorge
data(KarameaAtGorgeQts)
x <- KarameaAtGorgeQts

# Sub-daily to monthly ts
subdaily2monthly(x, FUN=mean, na.rm=TRUE)

hydroTSM

Time Series Management, Analysis and Interpolation for Hydrological Modelling

v0.6-0

GPL (>= 2)

Authors

Mauricio Zambrano-Bigiarini [aut, cre, cph] (<https://orcid.org/0000-0002-9536-643X>)

Initial release

daily2monthly

Description

Usage

Arguments

Author(s)

See Also

Examples

hydroTSM

We don't support your browser anymore