SeriesAggreg.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/SeriesAggreg.R
\encoding{UTF-8}
\name{SeriesAggreg}
\alias{SeriesAggreg}
\title{Conversion of time series to another time-step (aggregation only)}
\usage{
SeriesAggreg(TabSeries, TimeFormat, NewTimeFormat, ConvertFun,
  YearFirstMonth = 1, quiet = FALSE)
}
\arguments{
\item{TabSeries}{[POSIXlt+numeric] dataframe containing the vector of dates and the time series values}

\item{TimeFormat}{[character] desired format (i.e. "hourly", "daily", "monthly" or "yearly")}

\item{NewTimeFormat}{[character] desired format (i.e. "hourly", "daily", "monthly" or "yearly")}

\item{ConvertFun}{[character] names of aggregation functions (e.g. for P[mm],T[deg],Q[mm] : ConvertFun=c("sum","mean","sum"))}

\item{YearFirstMonth}{(optional) [numeric] integer used when NewTimeFormat="yearly" to set when the starting month of the year (e.g. 01 for calendar year or 09 for hydrological year starting in september)}

\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE}
}
\value{
[POSIXlt+numeric] dataframe containing a vector of aggregated dates and time series values
}
\description{
Conversion of time series to another time-step (aggregation only).
Warning : on the aggregated outputs, the dates correpond to the beginning ot the time-step
(e.g. for daily time-series 01/03/2005 00:00 = value for period 01/03/2005 00:00 - 01/03/2005 23:59 )
(e.g. for monthly time-series 01/03/2005 00:00 = value for period 01/03/2005 00:00 - 31/03/2005 23:59 )
(e.g. for yearly time-series 01/03/2005 00:00 = value for period 01/03/2005 00:00 - 28/02/2006 23:59 )
}
\examples{
## load of catchment data
require(airGR)

## preparation of the initial time series data frame at the daily time-step
data(L0123002)
TabSeries  <- data.frame(BasinObs$DatesR,BasinObs$P,BasinObs$E,BasinObs$T,BasinObs$Qmm)
TimeFormat <- "daily"

## conversion at the monthly time-step
NewTimeFormat <- "monthly"
ConvertFun    <- c("sum","sum","mean","sum")
NewTabSeries  <- SeriesAggreg(TabSeries=TabSeries,TimeFormat,NewTimeFormat,ConvertFun)

## conversion at the yearly time-step
NewTimeFormat <- "yearly"
ConvertFun <- c("sum","sum","mean","sum")
NewTabSeries <- SeriesAggreg(TabSeries=TabSeries,TimeFormat,NewTimeFormat,ConvertFun)

}
\author{
Laurent Coron (March 2015)
}