Package 'evapoRe'

Title: Evapotranspiration R Recipes
Description: An R-based application for exploratory data analysis of global EvapoTranspiration (ET) datasets. 'evapoRe' enables users to download, validate, visualize, and analyze multi-source ET data across various spatio-temporal scales. Also, the package offers calculation methods for estimating potential ET (PET), including temperature-based approaches described in : Oudin et al., (2005) <doi:10.1016/j.jhydrol.2004.08.026>. 'evapoRe' supports hydrological modeling, climate studies, agricultural research, and other data-driven fields by facilitating access to ET data and offering powerful analysis capabilities. Users can seamlessly integrate the package into their research applications and explore diverse ET data at different resolutions.
Authors: Akbar Rahmati Ziveh [aut, cre] , Mijael Rodrigo Vargas Godoy [aut] , Vishal Thakur [ctb] , Yannis Markonis [aut, ths]
Maintainer: Akbar Rahmati Ziveh <[email protected]>
License: GPL-3
Version: 1.0.0
Built: 2025-04-02 12:39:49 UTC
Source: https://github.com/akbarr1184/evapore

Help Index

Detect Extreme Evaporation Events (ExEvE)

Description

The function detect_exeve identifies extreme evaporation events based on standardized evaporation and extreme thresholds.

Usage

detect_exeve(x, EXTREMES_THRES = 0.95, LOW_THRES = 0.8)

Arguments

x

A data.table containing columns: lon, lat, date, and value, representing daily evaporation values.
EXTREMES_THRES

Numeric. Quantile threshold used to define extreme evaporation events. Default is 0.95.
LOW_THRES

Numeric. Lower quantile threshold. Default is 0.80.

Value

A data.table with original columns and added columns:

  • std_value — standardized evaporation

  • pentad_std_q80, pentad_std_q95 — pentad thresholds

  • value_above_low_thres, extreme, evap_event — flags

  • above_low_thres_id, extreme_id, event_id — event group IDs

Examples

evap <- readRDS("czechia_evap_gleam.rds")
events <- detect_exeve(evap)

Download various evapotranspiration data products

Description

The function download_data downloads the selected data product.

Usage

download_data(
  data_name = "all",
  path = "",
  domain = "raw",
  time_res = "monthly",
  variable = "e"
)

Arguments

data_name

a character string with the name(s) of the desired data set. Suitable options are:

  • "all" for all of the below listed data sets (default),

  • "bess" for BESS,

  • "camele" for CAMELE,

  • "era5" for ERA5,

  • "era5-land" for ERA5-Land,

  • "fldas" for FLDAS,

  • "gldas-clsm-v2-0" for GLDAS CLSM version 2.0,

  • "gldas-clsm-v2-1" for GLDAS CLSM version 2.1,

  • "gldas-noah-v2-0" for GLDAS NOAH version 2.0,

  • "gldas-noah-v2-1" for GLDAS NOAH version 2.1,

  • "gldas-vic-v2-0" for GLDAS VIC version 2.0,

  • "gldas-vic-v2-1" for GLDAS VIC version 2.1,

  • "gleam-v3-7a" for GLEAM version 3.7a,

  • "gleam-v4-1a" for GLEAM version 4.1a,

  • "jra-55" for JRA-55,

  • "merra-2" for MERRA-2,

  • "terraclimate" for TerraClimate,

  • "etmonitor" for ETMonitor,

  • "etsynthesis" for SynthesizedET,

  • "sith" for Simple Terrestrial Hydrosphere model, version 2.

path

a character string with the path where the database will be downloaded.
domain

a character string with the desired domain data set. Suitable options are:

  • "raw" for default available spatial coverage,

  • "global" for data sets with global (land and ocean) coverage,

  • "land" for data sets with land only coverage,

  • "ocean", for data sets with ocean only coverage.

time_res

a character string with the desired time resolution. Suitable options are:

  • "daily",

  • "monthly",

  • "yearly".

variable

a character string specifying the variable to download (default = "e").

Value

No return value, called to download the required data sets.

Examples

download_data("gldas-vic-v2-1", tempdir())

Temperature Data Downloader

Description

Downloading Temperature data from different datasets

Usage

download_t_data(
  data_name,
  path = "",
  domain = "raw",
  time_res = "monthly",
  variable = "all"
)

Arguments

data_name

a character string indicating the dataset to download. Suitable options are:

  • "terraclimate" for TerraClimate dataset,

  • "cru" for CRU dataset,

  • "mswx" for MSWX dataset.

path

a character string with the path where the data will be downloaded.
domain

a character string with the desired domain data set. Suitable options are:

  • "raw" for default available spatial coverage,

  • "global" for data sets with global (land and ocean) coverage,

  • "land" for data sets with land only coverage,

  • "ocean" for data sets with ocean only coverage.

time_res

a character string with the desired time resolution. Suitable options are:

  • "monthly",

  • "yearly".

variable

a character string indicating the variable to download. Suitable options are: For TerraClimate dataset:

  • "t2m" for average temperature,

  • "tmin" for minimum temperature,

  • "tmax" for maximum temperature.

Use "all" to download all available variables for the dataset.

Value

No return value, called to download the required data sets.

Examples

download_t_data("cru", tempdir())

Monthly Evapotranspiration data

Description

A subset of GLDAS CLSM monthly Evapotranspiration data in mm over Spain. More detail about raw data can be found here.

Usage

gldas_clsm_esp_ts

Format

A data.table with 120 obs. of 2 variables:

date

IDate format %Y-%m-%d

value

monthly average values

Source

National Aeronautics and Space Administration (NASA)

Monthly Evapotranspiration data

Description

Global GLDAS monthly Evapotranspiration data in mm. More details of the raw data can be found here.

Usage

gldas_clsm_global_ts

Format

A data.table with 120 obs. of 2 variables:

date

IDate format %Y-%m-%d

value

monthly average values

Source

National Aeronautics and Space Administration (NASA)

Monthly Evapotranspiration data

Description

A subset of GLDAS monthly Evapotranspiration data in mm over -10-40E, 30-45N. More details of the raw data can be found here.

Usage

gldas_clsm_subset_ts

Format

A data.table with 120 obs. of 2 variables:

date

IDate format %Y-%m-%d

value

monthly average values

Source

National Aeronautics and Space Administration (NASA)

Multiply by days per month

Description

The function muldpm multiplies the value by days per month.

Usage

muldpm(x)

Arguments

x

a RasterBrick object with monthly data in [units/day]

Value

a RasterBrick object

Examples

tavg_brick <- raster::brick('terraclimate_tavg.nc')
pet_od <- pet(method = "od", tavg = tavg_brick)
pet_od <- muldpm(pet_od)

Potential Evapotranspiration

Description

The function pet estimates PET by different methods

Usage

pet(x, y = NULL, z = NULL, method = "od")

Arguments

x

a datatable with lon, lat, date, tavg, tmax, and tmin data, a Raster object containing tavg, or a file path to a .nc file containing tavg data.
y

a Raster object or file path to a .nc file containing tmax data (optional, required for certain methods).
z

a Raster object or file path to a .nc file containing tmin data (optional, required for certain methods).
method

a character string indicating the method to be used. Available options are:

  • "bc" for Blaney and Criddle (1950),

  • "br" for Baier and Robertson (1965),

  • "ha" for Hamon (1961),

  • "hs" for Hargreaves and Samani (1985),

  • "jh" for Jensen and Haise (1963),

  • "mb" for McGuinness and Bordne (1972),

  • "od" for Oudin (2005). Default,

  • "th" for Thornthwaite (1948).

Value

A Raster object containing potential evapotranspiration in [mm/day], and a data.table object with potential evapotranspiration in [mm/month].

Examples

#Calculate PET by Oudin 
tavg <- raster::brick("terraclimate_tavg_land_19580101_20221231_025_monthly.nc")
pet_oudin <- pet(tavg, method = "od")
pet_oudin <- muldpm(pet_oudin)

Monthly Potential Evapotranspiration data

Description

A subset of calculated monthly Potential Evapotranspiration data in mm over Spain. More details of the used method can be found ‘⁠https://www.sciencedirect.com/science/article/pii/S0022169404004056⁠’.

Usage

pet_oudin_esp_ts

Format

A data.table with 120 obs. of 2 variables:

date

IDate format %Y-%m-%d

value

monthly average values

Source

Data was calculated using the Oudin method based on raw temperature data. More details of the raw data can be found ‘⁠https://journals.ametsoc.org/view/journals/bams/103/3/BAMS-D-21-0145.1.xml⁠’.

Monthly Potential Evapotranspiration data

Description

Monthly Potential Evapotranspiration data in mm calculated by Oudin method. More details of the used method can be found ‘⁠https://www.sciencedirect.com/science/article/pii/S0022169404004056⁠’.

Usage

pet_oudin_global_ts

Format

A data.table with 120 obs. of 2 variables:

date

IDate format %Y-%m-%d

value

monthly average values

Source

Data was calculated using the Oudin method based on raw temperature data. More details of the raw data can be found ‘⁠https://journals.ametsoc.org/view/journals/bams/103/3/BAMS-D-21-0145.1.xml⁠’.

Monthly Potential Evapotranspiration data

Description

A subset of Monthly Potential Evapotranspiration data in mm calculated by Oudin method over -10-40E, 30-45N. More details of the used method can be found ‘⁠https://www.sciencedirect.com/science/article/pii/S0022169404004056⁠’.

Usage

pet_oudin_subset_ts

Format

A data.table with 120 obs. of 2 variables:

date

IDate format %Y-%m-%d

value

monthly average values

Source

Data was calculated using the Oudin method based on raw temperature data. More details of the raw data can be found ‘⁠https://journals.ametsoc.org/view/journals/bams/103/3/BAMS-D-21-0145.1.xml⁠’.