Check for gaps in date sequence

Description

Check for gaps in date sequence

Usage

check_date_continuity(dates)

Arguments

Value

A data frame with gap information, or NULL if no gaps

Check for extreme values in weather columns

Description

Check for extreme values in weather columns

Usage

check_extreme_values(data, key_cols, temp_range, radn_range, rain_range)

Arguments

Value

A data frame of rows with extreme values, or NULL if none found

Check for missing values in key columns

Description

Check for missing values in key columns

Usage

check_missing_values(data, key_cols)

Arguments

Value

A data frame with missing value counts, or NULL if no missing values

Check weather records for data quality issues

Description

This function validates weather records for:

• Continuous weather data (no gaps in dates)

• No missing values in key columns (mint, maxt, radn, rain)

• No extreme values (e.g., less than -100 or above 100 for temperature, less than 0 for radiation and rain)

• Latitude and longitude columns exist and contain a single non-NA value for all records

Usage

check_weather(
  data,
  key_cols = c("mint", "maxt", "radn", "rain"),
  temp_range = c(-100, 100),
  radn_range = c(0, 50),
  rain_range = c(0, 500),
  stop_on_error = FALSE
)

Arguments

Value

If stop_on_error is FALSE, returns a list with the following components:

If stop_on_error is TRUE and issues are found, the function stops with an error message.

Examples

file <- system.file("extdata/ppd_72150.met", package = "tidyweather")
records <- read_weather(file)
result <- check_weather(records)
if (result$is_valid) {
  print("Weather data passed all quality checks")
} else {
  print(result)
}

Get weather package option

Description

Retrieves the value of a specified option from the weather package configuration. This function provides access to package-level settings and preferences.

Usage

get_weather_option(name)

Arguments

Value

The value of the specified option, or NULL if the option does not exist.

Examples

# Get the default frost threshold
get_weather_option("extreme.frost_threshold")

Calculate the last frost day

Description

This function calculates the last frost day from a numeric vector of daily minimum temperatures using tidyverse principles.

Usage

last_frost_day(
  .data,
  threshold = get_weather_option("extreme.frost_threshold"),
  hemisphere = "south",
  require_full_year = get_weather_option("require_full_year")
)

Arguments

Value

An data.frame or tibble representing the day of year for the last frost, or NA if no frost occurs

Examples

file <- system.file("extdata/ppd_72150.met", package = "tidyweather")
records <- read_weather(file)
records |>
    dplyr::group_by(year) |>
    last_frost_day(require_full_year = FALSE)

Calculate the number of frost days

Description

This function calculates the number of frost days from a numeric vector of daily minimum temperatures using tidyverse principles.

Usage

number_frost_day(
  .data,
  threshold = get_weather_option("extreme.frost_threshold"),
  require_full_year = get_weather_option("require_full_year")
)

Arguments

Value

An data.frame or tibble representing the number of frost days, or 0 if no frost occurs

Examples

file <- system.file("extdata/ppd_72150.met", package = "tidyweather")
records <- read_weather(file)
records |>
    dplyr::group_by(year) |> 
    number_frost_day(require_full_year = FALSE)

Read weather records from a file list and/or a folder list

Description

Read weather records from a file list and/or a folder list

Usage

read_weather(file, format = "APSIM", ...)

Arguments

Value

A data.frame which contains all weather data.

Examples

file <- system.file("extdata/ppd_72150.met", package = "tidyweather")
records <- read_weather(file)
head(records)

Summarise Weather Extremes and Key Indicators

Description

This function calculates summary metrics for weather data, including the number of frost days and the last frost day, grouped by one or more grouping variables. The function uses package-wide options for thresholds and year completeness.

Usage

summarise_weather(.data)

Arguments

Details

The function retrieves thresholds and settings from the global tidyweather options via weather_options(). The default frost threshold is get_weather_option("extreme.frost_threshold") and require_full_year is get_weather_option("require_full_year"). These can be changed using weather_options().

This function is designed to work with grouped tibbles (e.g., after dplyr::group_by()), applying the summary per group.

Value

A tibble with one row per group, containing the following columns:

number_frost_days

Number of days where minimum temperature is below the frost threshold.

last_frost_day

The day of year of the last frost (or NA if none).

Examples

library(dplyr)

# Example weather data (daily minimum temperatures)
weather_data <- read_weather(system.file("extdata/ppd_72150.met", package = "tidyweather"))

# Summarise without grouping
weather_options(require_full_year = FALSE)
summarise_weather(weather_data)

# Summarise by group (e.g., year)
weather_data_grouped <- weather_data %>% group_by(year)
summarise_weather(weather_data_grouped)

Set or get options for tidyweather

Description

This function allows users to get or set configuration options for the tidyweather package.

Usage

weather_options(...)

Arguments

Details

The options are managed via a nested structure that distinguishes between the tidyweather package.

Value

If called with no arguments, returns all current options. If called with named arguments, updates and returns the modified options.

Supported options

extreme.frost_threshold

Frost threshold for extreme weather events.

require_full_year

Whether to require a full year of data for calculations.

Examples

# Get all options
weather_options()

# Set frost_threshold
weather_options(extreme.frost_threshold = 2)

Reset all tidyweather options to defaults

Description

This restores all package settings to their initial defaults as defined when tidyweather was loaded. Use this if you want to undo all customizations.

Usage

weather_reset()

Value

Invisibly returns the default settings after reset.

Examples

weather_options(extreme.frost_threshold = -2)
weather_reset()
weather_options()

Write weather data to file

Description

Exports weather records to a file in the specified format. Currently supports APSIM format for agricultural modeling applications.

Usage

write_weather(records, file, format = "APSIM", overwrite = FALSE)

Arguments

Value

Invisibly returns the file path of the written file

Examples

# Read sample weather data from package
file <- system.file("extdata/ppd_72150.met", package = "tidyweather")
records <- read_weather(file)

# Write to temporary file
temp_file <- tempfile(fileext = ".met")

# Write to APSIM format
write_weather(records, temp_file, format = "APSIM")

# Overwrite existing file
write_weather(records, temp_file, format = "APSIM", overwrite = TRUE)