tidyextreme (version 1.0.0)

calculate_R10mm: Calculate number of heavy precipitation days (R10mm)

Description

Counts the number of days per year when precipitation \(\geq\) 10 mm, following ETCCDI definition R10mm.

Usage

calculate_R10mm(
  df,
  frequency = "daily",
  time_col = NULL,
  prcp_col = NULL,
  precip_col = NULL,
  threshold = 10
)

Value

A data.frame with columns: year, R10mm

Arguments

df

Data frame with precipitation data

frequency

Temporal frequency: "daily" or "hourly" (string)

time_col

Name of the time column (string). Must be in a format recognizable by lubridate (e.g., Date for daily data, POSIXct for hourly data). Recommended formats: - Daily: YYYY-MM-DD (e.g., "2023-01-15") - Hourly: YYYY-MM-DD HH:MM:SS (e.g., "2023-01-15 14:30:00")

prcp_col

Name of precipitation column (daily data) (string)

precip_col

Name of precipitation column (hourly data) (string)

threshold

Precipitation threshold in mm (default: 10)

Examples

# Daily precipitation data
daily_prcp <- data.frame(
  date = seq(as.Date("2000-01-01"), as.Date("2002-12-31"), by = "day"),
  rainfall = pmax(0, rgamma(1096, shape = 0.5, scale = 10))
)

# Calculate number of days with precipitation \eqn{\geq} 10mm
calculate_R10mm(
  df = daily_prcp,
  frequency = "daily",
  time_col = "date",
  prcp_col = "rainfall"
)

# With custom threshold (15mm instead of 10mm)
calculate_R10mm(
  df = daily_prcp,
  frequency = "daily",
  time_col = "date",
  prcp_col = "rainfall",
  threshold = 15
)