From 2f27d4917c2d3354fb6c85b7108ce9a5a0858ee4 Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.fr>
Date: Thu, 30 Apr 2020 21:05:43 +0200
Subject: [PATCH] v1.4.7.2 docs: SeriesAggreg2 help page updated with new
methods #41 needs to be improved
---
DESCRIPTION | 2 +-
NEWS.md | 2 +-
man/SeriesAggreg2.Rd | 25 +++++++++++++++++++++++--
3 files changed, 25 insertions(+), 4 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
index fc2f62a1..cd205ce0 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,7 +1,7 @@
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.4.7.1
+Version: 1.4.7.2
Date: 2020-04-30
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
diff --git a/NEWS.md b/NEWS.md
index 41c36ecc..81136563 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -4,7 +4,7 @@
-### 1.4.7.1 Release Notes (2020-04-30)
+### 1.4.7.2 Release Notes (2020-04-30)
#### New features
diff --git a/man/SeriesAggreg2.Rd b/man/SeriesAggreg2.Rd
index c6064454..d2a892bd 100644
--- a/man/SeriesAggreg2.Rd
+++ b/man/SeriesAggreg2.Rd
@@ -3,6 +3,9 @@
\name{SeriesAggreg2}
\alias{SeriesAggreg2}
+\alias{SeriesAggreg2.data.frame}
+\alias{SeriesAggreg2.InputsModel}
+\alias{SeriesAggreg2.OutputsModel}
\title{Conversion of time series to another time step (aggregation only)}
@@ -18,14 +21,28 @@ Warning: on the aggregated outputs, the dates correspond to the beginning of the
\usage{
-SeriesAggreg2(TabSeries, Format, TimeFormat, NewTimeFormat, ConvertFun,
- YearFirstMonth = 1, TimeLag = 0, verbose = TRUE)
+\method{SeriesAggreg2}{data.frame}(TabSeries,
+Format, TimeFormat, NewTimeFormat,
+YearFirstMonth = 1, TimeLag = 0,
+verbose = TRUE, ..., ConvertFun)
+
+\method{SeriesAggreg2}{InputsModel}(TabSeries,
+Format, TimeFormat, NewTimeFormat,
+YearFirstMonth = 1, TimeLag = 0,
+verbose = TRUE, ..., simplify = FALSE)
+
+\method{SeriesAggreg2}{OutputsModel}(TabSeries,
+Format, TimeFormat, NewTimeFormat,
+YearFirstMonth = 1, TimeLag = 0,
+verbose = TRUE, ..., simplify = FALSE)
}
\arguments{
\item{TabSeries}{[POSIXt+numeric] data.frame containing the vector of dates (POSIXt) and the time series values numeric)}
+\item{...}{...}
+
\item{Format}{[character] output time step format (i.e. yearly times series: \code{"\%Y"}, monthly time series: \code{"\%Y\%m"}, daily time series: \code{"\%Y\%m\%d"}, monthly regimes \code{"\%m"}, daily regimes \code{"\%d"})}
\item{TimeFormat}{(deprecated) [character] input time step format (i.e. \code{"hourly"}, \code{"daily"}, \code{"monthly"} or \code{"yearly"})}
@@ -39,7 +56,11 @@ SeriesAggreg2(TabSeries, Format, TimeFormat, NewTimeFormat, ConvertFun,
\item{TimeLag}{(optional) [numeric] numeric indicating a time lag (in seconds) for the time series aggregation (especially useful to aggregate hourly time series into daily time series)}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default = \code{TRUE}}
+
+\item{simplify}{(optional) [boolean] XXXXXX, default = \code{FALSE}}
}
+
+
\value{
[POSIXct+numeric] data.frame containing a vector of aggregated dates (POSIXct) and time series values numeric)
}
--
GitLab