Package {hydrodownloadR}

Internal registry for available providers

Description

Internal registry for available providers

Usage

.hydro_registry

Format

An object of class environment of length 38.

Retrieve the complete BAFU NAWA Trend parameter catalogue

Description

The catalogue includes all physicochemical parameters, nutrients, micropollutants and the few hydrological parameters stored in NAWA. The parameter column shows how each provider parameter is handled by timeseries(). All entries classified as water_quality are returned together when parameter = "water_quality" is requested.

Usage

bafu_nawa_parameters(x, ...)

Arguments

Value

A tibble containing the provider's parameter catalogue.

Build a httr2 request with optional auth

Description

Build a httr2 request with optional auth

Usage

build_request(x, path, query = list(), headers = list())

Split a vector into chunks

Description

Split a vector into chunks

Usage

chunk_vec(x, size)

Safe column extract that doesn't warn on missing tibble columns

Description

Safe column extract that doesn't warn on missing tibble columns

Usage

col_or_null(df, col)

SYKE runoff station metadata (area & altitude)

Description

Catchment area and altitude for Finnish SYKE runoff stations. Area may be NA for a few stations; altitude may still be present. Used to compute discharge from runoff time series: discharge_m3s = (value_lps_per_km2 * area_km2) / 1000.

Usage

data(fi_syke_runoff_meta)

Format

A tibble with:

place_id

Character. SYKE Paikka_Id.

area

Numeric (km^2). May be NA.

altitude

Numeric (m). May be NA.

Source

Finnish Environment Institute (SYKE).

FR_HUBEAU precomputed station metadata

Description

Preloaded metadata for Hub'Eau stations, built offline from the Hub'Eau referentials plus scraped site/station fiches (area, site altitude, gauge-zero altitude, vertical datum at site). Used to speed up stations() for the FR_HUBEAU provider.

Format

A data frame/tibble with columns:

code_site

Character. Hub'Eau site code.

station_id

Character. Hub'Eau station code.

area

Numeric (km^2). Catchment area from site fiche; may be NA.

altitude_api

Numeric (m). API referential altitude (hydrometry in mm to m; temperature in m).

altitude_site

Numeric (m). Site altitude parsed from the site fiche; may be NA.

altitude_station

Numeric (m). "Cote du zero d'echelle" from station fiche; may be NA.

vertical_datum_site

Character. Site-level vertical datum label; may be NA.

retrieved_at

POSIXct (UTC). Timestamp when the row was scraped.

Details

Built by data-raw/fr_hubeau_meta_build.R. The file data/fr_hubeau_meta.rda is shipped with the package and may be refreshed out-of-band. A build-date string is also stored in the object attribute metadata_date.

Source

Hub'Eau APIs and https://www.hydro.eaufrance.fr/ site/station fiches.

Create a hydro service object

Description

Create a hydro service object

Usage

hydro_service(provider_id, ...)

Arguments

Value

An object of class "hydro_service" (a list) containing the provider configuration used by stations() and timeseries() (e.g. provider_id, provider_name, country, base_url, and other adapter-specific settings).

List available providers

Description

List available providers

Usage

hydro_services()

Value

A tibble with columns: provider_id, provider_name, country, base_url, license, license_link, access_class, reuse_class, is_open_data

Japan MLIT stations metadata snapshot

Description

A processed station metadata table used internally by the JP MLIT adapter. Coordinates from the official MLIT station pages are preferred when available. Coordinates from the supplied metadata CSV are used as a fallback.

Usage

data(jp_mlit_meta)

Format

A tibble/data.frame with one row per station:

station_id

MLIT station identifier (character).

station_name

English station name (character).

river

English river-system name (character).

lat

Selected latitude in WGS84 decimal degrees (double).

lon

Selected longitude in WGS84 decimal degrees (double).

area

Drainage area in square kilometres, if available (double).

altitude

Gauge-zero elevation in metres, if available (double).

station_name_original

Original Japanese station name (character).

lat_website

Latitude obtained from the official MLIT station page (double).

lon_website

Longitude obtained from the official MLIT station page (double).

coordinate_source

Source used for lat and lon. Either "MLIT website" or "MLIT metadata CSV" (character).

Source

Japan Ministry of Land, Infrastructure, Transport and Tourism (MLIT).

List available countries

Description

List available countries

Usage

list_countries()

Value

A character vector of country codes (e.g. ISO 3166-1 alpha-2) for which at least one provider is available.

Normalize likely-misencoded UTF-8 text (fix common UTF-8 mojibake)

Description

Normalize likely-misencoded UTF-8 text (fix common UTF-8 mojibake)

Usage

normalize_utf8(x)

Perform request with retry and exponential backoff

Description

Perform request with retry and exponential backoff

Usage

perform_request(req, max_tries = 5)

IMGW station metadata (packaged)

Description

Enriched station metadata provided by IMGW (see attr(., "source_stamp") for the source timestamp). Columns (tibble): station_id, station_name, river, lat_md, lon_md, area_md, altitude_md, vertical_datum_md.

Format

A tibble with one row per station.

Source

Provided directly by IMGW to GRDC.

Resolve date inputs based on mode

Description

Resolve date inputs based on mode

Usage

resolve_dates(mode, start_date, end_date)

List stations for a provider

Description

List stations for a provider

Usage

stations(x, ...)

Arguments

Value

A tibble with station metadata.

Examples

# Offline: enumerate providers (no network)
s <- hydro_services()
head(names(s))


# Online (opt-in): fetch stations
x <- hydro_service("SE_SMHI")
st <- stations(x)
head(st)

ANA stations (Brazil) - cache-first with optional update from inventory

Description

Loads the cached ANA station catalogue (if present) or rebuilds it from a locally downloaded SNIRH inventory (InventarioDD_MM_YYYY.zip / .mdb) when update = TRUE.

Usage

## S3 method for class 'hydro_service_BR_ANA'
stations(x, ...)

Arguments

Value

A tibble with ANA station metadata.

Retrieve time series for a provider

Description

Retrieve time series for a provider

Usage

timeseries(
  x,
  parameter,
  stations = NULL,
  start_date = NULL,
  end_date = NULL,
  mode = c("range", "complete"),
  ...
)

Arguments

Value

A tibble with columns: country, provider_id, provider_name, station_id, parameter, timestamp, value, unit, quality_code, source_url.

Examples

# Offline: construct a service object (no network)
x <- hydro_service("SE_SMHI")


# Online (opt-in): one station for a short range
st <- head(stations(x)$station_id, 1)
ts <- timeseries(x, parameter = "water_discharge",
                 stations = st,
                 start_date = "2020-01-01", end_date = "2020-01-10")
head(ts)

List supported parameters/units for a provider

Description

List supported parameters/units for a provider

Usage

timeseries_parameters(x, ...)

Arguments

Value

A tibble with columns: parameter, code, unit.

Transliterate to ASCII (remove diacritics); fallback to original on failure

Description

Transliterate to ASCII (remove diacritics); fallback to original on failure

Usage

to_ascii(x)