h_month: Monthly operations, based on a daily time-series

Description Usage Arguments Details Value Author(s) Examples

Description

Monthly operations, based on a daily time-series

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
h_month(
  file,
  op = "M",
  ba = NA,
  rmna = FALSE,
  climedit = FALSE,
  caledit_j = FALSE,
  caledit_m = FALSE,
  gapfill = FALSE,
  hts_year = FALSE
)

Arguments

file

Full file name of the daily time-series.

op

Operation: mean ("M") or sum ("S")

ba

Basin area in km2 or NA (default)

rmna

Remove NA values TRUE / FALSE (default)

climedit

Write a climatology file TRUE / FALSE (default)

caledit_j

Write an Excel file with daily calendar TRUE / FALSE (default)

caledit_m

Write an Excel file with monthly calendar TRUE / FALSE (default)

gapfill

Replace the missing months by the "climatology" value TRUE / FALSE (default)

hts_year

Extract the mean, max & min yearly values in hts files TRUE / FALSE (default)

Details

Based on a daily time-series, the function returns a monthly time-series, and computes a mean monthly climatology. It allows to consider or not the missing daily values: option rmna.

The function can also produce Excel files: with a calendar presentation (days in rows, months in columns, years in sheets): option caledit_j ; with the monthly means (or sums): option caledit_m. In addition, the missing values can be replaced by the mean of the existing values for other years : option gapfill.

Climatology files are by convention awarded to year 2000.

Generally, the values of the monthly climatologies are mean values (op="M"), except if they are volumes (e.g.: precipitation, evaporation, etc.). In these cases, the parameter op="S" must be precised.

If rmna = TRUE , the NA values are not taken into consideration for computing the sum or the mean.

In the case of discharge values, it is possible to compute monthly volumes expressed in mm. For that purpose, the basin area ba must be given in km2.

By default, the reference name of the time-series is <sensor.id>_<station.id>. It is possible to change it giving a value to the parameter ref.

Value

A list of timeSeries class objects including: [1] raw monthly data; [2] 12 climatology means (January to December); [3] gapfilled monthly data, if the option gapfill is TRUE.

Three hts time series files: a monthly data file with the suffix _M, a climatology data file with the suffix _C and, optionally, a gapfilled monthly data file with the suffix _G.

Optionally, two Excel files with calendar presented values:, one with daily data and one with monthly data, the fist one with a ad_ prefix and the second one with the am_ prefix.

Author(s)

P. Chevallier - Oct 2017- Apr 2020

Examples

1
2
3
4
5
## Not run: 

res <- h_month("foo.ts",op="S", ba=135, caledit_m = TRUE)

## End(Not run)

htsr documentation built on Jan. 3, 2022, 5:10 p.m.