The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.

Title: Download Radar Data for Biological Research
Version: 0.2.0
Description: Load polar volume and vertical profile data for aeroecological research directly into R. With 'getRad' you can access data from several sources in Europe and the US and standardize it to facilitate further exploration in tools such as 'bioRad'.
License: MIT + file LICENSE
URL: https://github.com/aloftdata/getRad, https://aloftdata.github.io/getRad/
BugReports: https://github.com/aloftdata/getRad/issues
Depends: R (≥ 4.1.0)
Imports: bioRad, cachem, cli, dplyr (≥ 1.1.0), glue, httr2 (≥ 1.1.1), lubridate, purrr (≥ 1.0.0), rlang, tibble, tools, utils, vroom, xml2
Suggests: askpass, htmltools, keyring, knitr, leaflet, rhdf5, rnaturalearth, rnaturalearthdata, sf, testthat (≥ 3.0.0), tidyr, vol2birdR, withr
VignetteBuilder: knitr
Config/testthat/edition: 3
Encoding: UTF-8
RoxygenNote: 7.3.2
Config/Needs/website: rmarkdown, leafpop, htmltools
NeedsCompilation: no
Packaged: 2025-07-11 14:23:40 UTC; bart
Author: Bart Kranstauber ORCID iD [aut, cre] (affiliation: University of Amsterdam), Pieter Huybrechts ORCID iD [aut] (affiliation: Research Institute for Nature and Forest (INBO)), Peter Desmet ORCID iD [aut] (affiliation: Research Institute for Nature and Forest (INBO)), Cecilia Nilsson ORCID iD [ctb] (affiliation: Lund University), Alexander Tedeschi ORCID iD [ctb] (affiliation: Cornell Lab of Ornithology), Hidde Leijnse ORCID iD [ctb] (affiliation: Royal Netherlands Meteorological Institute), Bart Hoekstra ORCID iD [ctb] (affiliation: University of Amsterdam), University of Amsterdam ROR ID [cph], Biodiversa+ [fnd] (https://hirad.science/)
Maintainer: Bart Kranstauber <b.kranstauber@uva.nl>
Repository: CRAN
Date/Publication: 2025-07-16 15:10:02 UTC

getRad: Download Radar Data for Biological Research

Description

Load polar volume and vertical profile data for aeroecological research directly into R. With 'getRad' you can access data from several sources in Europe and the US and standardize it to facilitate further exploration in tools such as 'bioRad'.

Author(s)

Maintainer: Bart Kranstauber b.kranstauber@uva.nl (ORCID) (University of Amsterdam)

Authors:

Other contributors:

See Also

Useful links:

Get polar volume (PVOL) data from supported sources

Description

Gets polar volume data from supported sources and returns it as a (list of) polar volume objects. The source is automatically detected based on the provided radar.

Usage

get_pvol(radar = NULL, datetime = NULL, ...)

Arguments

radar

Name of the radar (odim code) as a character string (e.g. "nlhrw" or "fikor").

datetime

Either:

  • A single POSIXct, for which the most representative data file is downloaded. In most cases this will be the time before.

  • A lubridate::interval() or two POSIXct, between which all data files are downloaded.

...

Additional arguments passed on to reading functions, for example param = "all" to the bioRad::read_pvolfile().

Details

For more details on supported sources, see vignette("supported_sources"). Within supported countries there might also be temporal restrictions on the radars that are operational. For example, radars with the status 0 in get_weather_radars("opera") are currently not operational.

Not all radars in the nexrad archive can be read successfully. Radars associated with the Terminal Doppler Weather Radar (TDWR) program can not be read. These can be identified using the stntype column in get_weather_radars("nexrad").

Value

Either a polar volume or a list of polar volumes. See bioRad::summary.pvol() for details.

Examples


# Get PVOL data for a single radar and datetime
get_pvol("deess", as.POSIXct(Sys.Date()))

# Get PVOL data for multiple radars and a single datetime
get_pvol(
  c("deess", "dehnr", "fianj", "czska", "KABR"),
  as.POSIXct(Sys.Date())
)

Get vertical profile time series (VPTS) data from supported sources

Description

Gets vertical profile time series data from supported sources and returns it as a (list of) of vpts objects or a dplyr::tibble().

Usage

get_vpts(
  radar,
  datetime,
  source = c("baltrad", "uva", "ecog-04003", "rmi"),
  return_type = c("vpts", "tibble")
)

Arguments

radar

Name of the radar (odim code) as a character string (e.g. "nlhrw" or "fikor").

datetime

Either:

  • A POSIXct datetime (or character representation), for which the data file is downloaded.

  • A Date date (or character representation), for which all data files are downloaded.

  • A vector of datetimes or dates, between which all data files are downloaded.

  • A lubridate::interval(), between which all data files are downloaded.

source

Source of the data. One of "baltrad", "uva", "ecog-04003" or "rmi". Only one source can be queried at a time. If not provided, "baltrad" is used.

return_type

Type of object that should be returned. Either:

Details

For more details on supported sources, see vignette("supported_sources").

Value

Either a vpts object, a list of vpts objects or a tibble. See bioRad::summary.vpts for details.

Examples


# Get VPTS data for a single radar and date
get_vpts(radar = "bejab", datetime = "2023-01-01", source = "baltrad")
get_vpts(radar = "bejab", datetime = "2020-01-19", source = "rmi")

# Get VPTS data for multiple radars and a single date
get_vpts(
  radar = c("dehnr", "deflg"),
  datetime = lubridate::ymd("20171015"),
  source = "baltrad"
)

# Get VPTS data for a single radar and a date range
get_vpts(
  radar = "bejab",
  datetime = lubridate::interval(
    lubridate::ymd_hms("2023-01-01 00:00:00"),
    lubridate::ymd_hms("2023-01-02 00:14:00")
  ),
  source = "baltrad"
)
get_vpts("bejab", lubridate::interval("20210101", "20210301"))

# Get VPTS data for a single radar, date range and non-default source
get_vpts(radar = "bejab", datetime = "2016-09-29", source = "ecog-04003")

# Return a tibble instead of a vpts object
get_vpts(
  radar = "chlem",
  datetime = "2023-03-10",
  source = "baltrad",
  return_type = "tibble"
)

Get VPTS data from the Aloft bucket

Description

Gets VPTS data from the Aloft bucket.

Usage

get_vpts_aloft(
  radar_odim_code,
  rounded_interval,
  source = c("baltrad", "uva", "ecog-04003"),
  coverage = get_vpts_coverage_aloft()
)

Arguments

radar_odim_code

Radar ODIM code.

rounded_interval

Interval to fetch data for, rounded to nearest day.

source

Source of the data. One of baltrad, uva or ecog-04003.

coverage

A data frame containing the coverage of the Aloft bucket. If not provided, it will be fetched from via the internet.

Details

By default, data from the Aloft bucket are retrieved from https://aloftdata.s3-eu-west-1.amazonaws.com. This can be changed by setting options(getRad.aloft_data_url) to any desired url.

Value

A tibble with VPTS data.

Inner working

Get VPTS file coverage from supported sources

Description

Gets the VPTS file coverage from supported sources per radar and date.

Usage

get_vpts_coverage(source = c("baltrad", "uva", "ecog-04003", "rmi"), ...)

Arguments

source

Source of the data. One or more of "baltrad", "uva", "ecog-04003" or "rmi". If not provided, "baltrad" is used. Alternatively "all" can be used if data from all sources should be returned.

...

Arguments passed on to internal functions.

Value

A data.frame or tibble with at least three columns, source, radar and date to indicate the combination for which data exists.

Examples


get_vpts_coverage()

Get VPTS data from RMI

Description

Get VPTS data from RMI_DATASET_CROW.

Usage

get_vpts_rmi(radar_odim_code, rounded_interval)

Arguments

radar_odim_code

Radar ODIM code.

rounded_interval

Interval to fetch data for, rounded to nearest day.

Value

A tibble with VPTS data.

Get weather radar metadata

Description

Gets weather radar metadata from OPERA and/or NEXRAD.

Usage

get_weather_radars(source = c("opera", "nexrad"), use_cache = TRUE, ...)

Arguments

source

Source of the metadata. "opera", "nexrad" or "all". If not provided, "opera" is used.

use_cache

Logical indicating whether to use the cache. Default is TRUE. If FALSE the cache is ignored and the file is fetched anew. This can also be useful if you want to force a refresh of the cache.

...

Additional arguments passed on to reading functions per source, currently not used.

Details

The source files for this function are:

Value

A sf or tibble with weather radar metadata. In all cases the column source is added to indicate the source of the data and radar to show the radar identifiers used in other functions like get_pvol() and get_vpts().

Examples


# Get radar metadata from OPERA
get_weather_radars(source = "opera")

# Get radar metadata from NEXRAD
get_weather_radars(source = "nexrad")

Function to set the cache for a getRad specific httr2 request

Description

Function to set the cache for a getRad specific httr2 request

Usage

req_cache_getrad(
  req,
  use_cache = TRUE,
  max_age = getOption("getRad.max_cache_age_seconds", default = 6 * 60 * 60),
  max_n = getOption("getRad.max_cache_n", default = Inf),
  max_size = getOption("getRad.max_cache_size_bytes", default = 1024 * 1024 * 1024),
  ...
)

Arguments

req

httr2 request.

use_cache

Logical indicating whether to use the cache. Default is TRUE. If FALSE the cache is ignored and the file is fetched anew. This can also be useful if you want to force a refresh of the cache.

max_n, max_age, max_size

Automatically prune the cache by specifying one or more of:

  • max_age: to delete files older than this number of seconds.

  • max_n: to delete files (from oldest to newest) to preserve at most this many files.

  • max_size: to delete files (from oldest to newest) to preserve at most this many bytes.

The cache pruning is performed at most once per minute.

...

Additional arguments passed to httr2::req_cache().

Set or get secrets from the keyring

Description

Some services require credentials to access data. This function uses keyring to safely store those credentials on your computer.

Usage

set_secret(name, secret = NULL)

get_secret(name)

Arguments

name

Name of the secret to set or get as a character (e.g. "nl_api_key").

secret

Optionally a character string with the secret, alternatively the system will prompt the user.

Details

When working with a cluster it might be advantageous to use a specific keyring, this can be done by setting the keyring_backend option in R.

The package uses the option getRad.key_prefix as a prefix to all keys stored. If you want to use multiple keys for the same api you can manipulate this option.

Value

set_secret() returns TRUE when a secret has successfully been set. get_secret() returns the secret as a character string.

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.