docs(man): add explanations in the 'details' section of the SeriesAggreg doc

Refs #128

docs(man): add explanations in the 'details' section of the SeriesAggreg doc
Refs #128
f627dd32 · Delaigue Olivier · 267ee1b7 · f627dd32
Commit f627dd32 authored 3 years ago by Delaigue Olivier
Hide whitespace changes
Inline Side-by-side

Showing

with 2 additions and 0 deletions
+2 -0
--- a/man/SeriesAggreg.Rd
+++ b/man/SeriesAggreg.Rd
@@ -30,6 +30,8 @@ Warning: on the aggregated outputs, the dates correspond to the beginning of the
  E.g. use "Q90" for calculating 90th percentile in the aggregation.
  The formula used is: \code{quantile(x, probs = perc / 100, type = 8, na.rm = TRUE)}.

+  As there are multiple ways to take into account missing values in aggregation functions, \code{NA}s are not supported by \code{SeriesAggreg} and it provides \code{NA} values when \code{NA}s are present in the \code{x} input.
+
 }