v1.4.4.3 DOC: SeriesAgreg2 help page corrected #25 #41

- wrong argument name
- minor text revisions

DESCRIPTION

 Package: airGR
 Type: Package
 Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.4.4.2
+Version: 1.4.4.3
 Date: 2020-04-07
 Authors@R: c(
   person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),

NEWS.md

@@ -4,7 +4,7 @@
 
 
 
-### 1.4.4.2 Release Notes (2020-04-07)
+### 1.4.4.3 Release Notes (2020-04-07)
 
 #### New features
 

man/SeriesAggreg2.Rd

@@ -18,7 +18,7 @@ Warning : on the aggregated outputs, the dates correspond to the beginning of th
 
 
 \usage{
-SeriesAggreg2(TabSeries, TimeFormat, ConvertFun,
+SeriesAggreg2(TabSeries, Format, ConvertFun,
               YearFirstMonth = 1, TimeLag = 0, verbose = TRUE)
 }
 
@@ -26,11 +26,11 @@ SeriesAggreg2(TabSeries, TimeFormat, ConvertFun,
 \arguments{
 \item{TabSeries}{[POSIXt+numeric] data.frame containing the vector of dates (POSIXt) and the time series values numeric)}
 
-\item{TimeFormat}{[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{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{ConvertFun}{[character] names of aggregation functions (e.g. for P[mm], T[degC], Q[mm] : \code{ConvertFun = c("sum", "mean", "sum"}))}
 
-\item{YearFirstMonth}{(optional) [numeric] integer used when \code{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{YearFirstMonth}{(optional) [numeric] integer used when \code{Format = "\%Y"} to set when the starting month of the year (e.g. 01 for calendar year or 09 for hydrological year starting in September)}
 
 \item{TimeLag}{(optional) [numeric] numeric indicating a time lag (in seconds) for the time series aggregation (especially useful to aggregate hourly time series in daily time series)}
 
@@ -52,15 +52,15 @@ TabSeries <- BasinObs[, c("DatesR", "P", "E", "T", "Qmm")]
 
 ## monthly time series
 NewTabSeries <- SeriesAggreg2(TabSeries = TabSeries,
-                              TimeFormat = "\%Y\%m",
+                              Format = "\%Y\%m",
                               ConvertFun = c("sum", "sum", "mean", "sum"))
-head(NewTabSeries)
+str(NewTabSeries)
 
 ## monthly time regimes
 NewTabSeries <- SeriesAggreg2(TabSeries = TabSeries,
-                              TimeFormat = "\%m",
+                              Format = "\%m",
                               ConvertFun = c("sum", "sum", "mean", "sum"))
-head(NewTabSeries)
+str(NewTabSeries)
 }