era5ify_bbox: Download and process ERA5 data for a bounding box

View source: R/core.R

ERA5ifyBboxR Documentation

Download and process ERA5 data for a bounding box

Description

Download and process ERA5 data for a bounding box

Usage

ERA5ifyBbox(...)

era5ify_bbox(
  request_id,
  variables,
  start_date,
  end_date,
  north,
  south,
  east,
  west,
  dataset_type = "single",
  pressure_levels = NULL,
  frequency = "hourly",
  resolution = 0.25,
  save_raw = FALSE,
  output_dir = tempdir(),
  use_cache = TRUE,
  convert_units = TRUE,
  verbose = FALSE
)

Arguments

...

Arguments passed to the main function (used by aliases).

request_id

Unique identifier for the data request.

variables

List of ERA5 variables to download.

start_date

Start date in "YYYY-MM-DD" format.

end_date

End date in "YYYY-MM-DD" format.

north

Northern latitude boundary.

south

Southern latitude boundary.

east

Eastern longitude boundary.

west

Western longitude boundary.

dataset_type

Type of dataset ("single" or "pressure").

pressure_levels

Pressure levels for pressure dataset.

frequency

Temporal frequency ("hourly", "daily", "monthly").

resolution

Spatial resolution in degrees (default: 0.25).

save_raw

If TRUE, save the raw downloaded files.

output_dir

Directory for the saved files (default: tempdir()).

use_cache

If TRUE, use cached data when it is available (default: TRUE).

convert_units

If TRUE, convert units to user-friendly formats (default: TRUE). When TRUE, the function returns temperature variables in Celsius (converted from Kelvin). It returns precipitation variables in mm (converted from meters).

verbose

If TRUE, print detailed progress messages.

Value

data.frame with processed climate data. When convert_units = TRUE:

  • Temperature variables (e.g., 2m_temperature): Celsius

  • Precipitation variables (e.g., total_precipitation): mm

  • Other variables: original ERA5 units

Examples


setup_cds_credentials(key = "your-cds-api-key")

data <- era5ify_bbox(
  request_id = "my_request",
  variables = c("2m_temperature", "total_precipitation"),
  start_date = "2023-01-01",
  end_date = "2023-01-31",
  north = 40, south = 35, east = -70, west = -75
)
# Temperature is in Celsius. Precipitation is in mm.


varunayan documentation built on Oct. 30, 2026, 1:07 a.m.