climate_input: Climate Input Function

View source: R/rIACI.R

climate_inputR Documentation

Climate Input Function

Description

Processes climate data and calculates necessary statistics for climate index calculations.

Usage

climate_input(
  tmax = NULL,
  tmin = NULL,
  prec = NULL,
  wind = NULL,
  dates = NULL,
  base.range = c(1961, 1990),
  n = 5,
  quantiles = NULL,
  temp.qtiles = c(0.1, 0.9),
  wind.qtile = 0.9,
  max.missing.days = c(annual = 15, monthly = 3),
  min.base.data.fraction.present = 0.1
)

Arguments

tmax

Numeric vector. Maximum temperature data.

tmin

Numeric vector. Minimum temperature data.

prec

Numeric vector. Precipitation data.

wind

Numeric vector. Wind speed data.

dates

Date vector. Dates corresponding to the data.

base.range

Numeric vector of length 2. Base range years for calculations (default is c(1961, 1990)).

n

Integer. Window size for running averages (default is 5).

quantiles

List. Pre-calculated quantiles (optional).

temp.qtiles

Numeric vector. Temperature quantiles to calculate (default is c(0.10, 0.90)).

wind.qtile

Numeric. Wind quantile to calculate (default is 0.90).

max.missing.days

Named numeric vector. Maximum allowed missing days for annual and monthly data (default is c(annual = 15, monthly = 3)).

min.base.data.fraction.present

Numeric. Minimum fraction of data required in base range (default is 0.1).

Value

A list containing processed data and related information for climate index calculations.

Examples


# 1. Generate a daily date sequence from 1960-01-01 to 2020-12-31
dates <- seq.Date(
  from = as.Date("1960-01-01"),
  to   = as.Date("2020-12-31"),
  by   = "day"
)

# 2. Create random weather data for each date
n <- length(dates)
tmax <- runif(n, min = 5, max = 40)
tmin <- runif(n, min = -10,  max = 5)
# Example: use a Poisson distribution to simulate precipitation
prec <- rpois(n, lambda = 2)
# Random wind speeds, e.g., 0 to 10 m/s
wind <- runif(n, min = 0, max = 10)

# 3. Construct the climate_input object
ci <- climate_input(
  tmax  = tmax,
  tmin  = tmin,
  prec  = prec,
  wind  = wind,
  dates = dates
)

# 4. Examine the structure of ci
str(ci)


rIACI documentation built on April 12, 2025, 9:16 a.m.