diff --git a/CITATION.cff b/CITATION.cff index 5625ca1..c901d9d 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -8,7 +8,7 @@ message: 'To cite package "getRad" in publications use:' type: software license: MIT title: 'getRad: Download Radar Data for Biological Research' -version: 0.2.4 +version: 0.2.4.9000 doi: 10.32614/CRAN.package.getRad abstract: Load polar volume and vertical profile data for aeroecological research directly into R. With 'getRad' you can access data from several sources in Europe @@ -45,4 +45,477 @@ keywords: - r-package - radar - rstats +references: +- type: software + title: 'R: A Language and Environment for Statistical Computing' + notes: Depends + url: https://www.R-project.org/ + authors: + - name: R Core Team + institution: + name: R Foundation for Statistical Computing + address: Vienna, Austria + year: '2026' + version: '>= 4.1.0' +- type: software + title: bioRad + abstract: 'bioRad: Biological Analysis and Visualization of Weather Radar Data' + notes: Imports + url: https://github.com/adokter/bioRad/ + repository: https://CRAN.R-project.org/package=bioRad + authors: + - family-names: Dokter + given-names: Adriaan M. + email: biorad@cornell.edu + orcid: https://orcid.org/0000-0001-6573-066X + - family-names: Desmet + given-names: Peter + email: peter.desmet@inbo.be + orcid: https://orcid.org/0000-0002-8442-8025 + - family-names: Kranstauber + given-names: Bart + email: b.kranstauber@uva.nl + orcid: https://orcid.org/0000-0001-8303-780X + - family-names: Nilsson + given-names: Cecilia + email: cecilia.nilsson709@gmail.com + orcid: https://orcid.org/0000-0001-8957-4411 + - family-names: Tedeschi + given-names: Alexander + email: alexander.tedeschi@cornell.edu + orcid: https://orcid.org/0000-0003-0772-6931 + - family-names: Van Hoey + given-names: Stijn + email: stijnvanhoey@gmail.com + orcid: https://orcid.org/0000-0001-6413-3185 + year: '2026' + doi: 10.32614/CRAN.package.bioRad +- type: software + title: cachem + abstract: 'cachem: Cache R Objects with Automatic Pruning' + notes: Imports + url: https://cachem.r-lib.org/ + repository: https://CRAN.R-project.org/package=cachem + authors: + - family-names: Chang + given-names: Winston + email: winston@posit.co + year: '2026' + doi: 10.32614/CRAN.package.cachem +- type: software + title: cli + abstract: 'cli: Helpers for Developing Command Line Interfaces' + notes: Imports + url: https://cli.r-lib.org + repository: https://CRAN.R-project.org/package=cli + authors: + - family-names: Csárdi + given-names: Gábor + email: gabor@posit.co + year: '2026' + doi: 10.32614/CRAN.package.cli +- type: software + title: dplyr + abstract: 'dplyr: A Grammar of Data Manipulation' + notes: Imports + url: https://dplyr.tidyverse.org + repository: https://CRAN.R-project.org/package=dplyr + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + orcid: https://orcid.org/0000-0003-4757-117X + - family-names: François + given-names: Romain + orcid: https://orcid.org/0000-0002-2444-4226 + - family-names: Henry + given-names: Lionel + - family-names: Müller + given-names: Kirill + orcid: https://orcid.org/0000-0002-1416-3412 + - family-names: Vaughan + given-names: Davis + email: davis@posit.co + orcid: https://orcid.org/0000-0003-4777-038X + year: '2026' + doi: 10.32614/CRAN.package.dplyr + version: '>= 1.1.0' +- type: software + title: glue + abstract: 'glue: Interpreted String Literals' + notes: Imports + url: https://glue.tidyverse.org/ + repository: https://CRAN.R-project.org/package=glue + authors: + - family-names: Hester + given-names: Jim + orcid: https://orcid.org/0000-0002-2739-7082 + - family-names: Bryan + given-names: Jennifer + email: jenny@posit.co + orcid: https://orcid.org/0000-0002-6983-2759 + year: '2026' + doi: 10.32614/CRAN.package.glue +- type: software + title: httr2 + abstract: 'httr2: Perform HTTP Requests and Process the Responses' + notes: Imports + url: https://httr2.r-lib.org + repository: https://CRAN.R-project.org/package=httr2 + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + year: '2026' + doi: 10.32614/CRAN.package.httr2 + version: '>= 1.1.1' +- type: software + title: lubridate + abstract: 'lubridate: Make Dealing with Dates a Little Easier' + notes: Imports + url: https://lubridate.tidyverse.org + repository: https://CRAN.R-project.org/package=lubridate + authors: + - family-names: Spinu + given-names: Vitalie + email: spinuvit@gmail.com + - family-names: Grolemund + given-names: Garrett + - family-names: Wickham + given-names: Hadley + year: '2026' + doi: 10.32614/CRAN.package.lubridate +- type: software + title: purrr + abstract: 'purrr: Functional Programming Tools' + notes: Imports + url: https://purrr.tidyverse.org/ + repository: https://CRAN.R-project.org/package=purrr + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + orcid: https://orcid.org/0000-0003-4757-117X + - family-names: Henry + given-names: Lionel + email: lionel@posit.co + year: '2026' + doi: 10.32614/CRAN.package.purrr + version: '>= 1.0.0' +- type: software + title: rlang + abstract: 'rlang: Functions for Base Types and Core R and ''Tidyverse'' Features' + notes: Imports + url: https://rlang.r-lib.org + repository: https://CRAN.R-project.org/package=rlang + authors: + - family-names: Henry + given-names: Lionel + email: lionel@posit.co + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + year: '2026' + doi: 10.32614/CRAN.package.rlang +- type: software + title: tibble + abstract: 'tibble: Simple Data Frames' + notes: Imports + url: https://tibble.tidyverse.org/ + repository: https://CRAN.R-project.org/package=tibble + authors: + - family-names: Müller + given-names: Kirill + email: kirill@cynkra.com + orcid: https://orcid.org/0000-0002-1416-3412 + - family-names: Wickham + given-names: Hadley + email: hadley@rstudio.com + year: '2026' + doi: 10.32614/CRAN.package.tibble +- type: software + title: tools + abstract: 'R: A Language and Environment for Statistical Computing' + notes: Imports + authors: + - name: R Core Team + institution: + name: R Foundation for Statistical Computing + address: Vienna, Austria + year: '2026' +- type: software + title: utils + abstract: 'R: A Language and Environment for Statistical Computing' + notes: Imports + authors: + - name: R Core Team + institution: + name: R Foundation for Statistical Computing + address: Vienna, Austria + year: '2026' +- type: software + title: vroom + abstract: 'vroom: Read and Write Rectangular Text Data Quickly' + notes: Imports + url: https://vroom.tidyverse.org + repository: https://CRAN.R-project.org/package=vroom + authors: + - family-names: Hester + given-names: Jim + orcid: https://orcid.org/0000-0002-2739-7082 + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + orcid: https://orcid.org/0000-0003-4757-117X + - family-names: Bryan + given-names: Jennifer + email: jenny@posit.co + orcid: https://orcid.org/0000-0002-6983-2759 + year: '2026' + doi: 10.32614/CRAN.package.vroom +- type: software + title: withr + abstract: 'withr: Run Code ''With'' Temporarily Modified Global State' + notes: Imports + url: https://withr.r-lib.org + repository: https://CRAN.R-project.org/package=withr + authors: + - family-names: Hester + given-names: Jim + - family-names: Henry + given-names: Lionel + email: lionel@posit.co + - family-names: Müller + given-names: Kirill + email: krlmlr+r@mailbox.org + - family-names: Ushey + given-names: Kevin + email: kevinushey@gmail.com + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + - family-names: Chang + given-names: Winston + year: '2026' + doi: 10.32614/CRAN.package.withr +- type: software + title: xml2 + abstract: 'xml2: Parse XML' + notes: Imports + url: https://xml2.r-lib.org + repository: https://CRAN.R-project.org/package=xml2 + authors: + - family-names: Wickham + given-names: Hadley + - family-names: Hester + given-names: Jim + - family-names: Ooms + given-names: Jeroen + email: jeroenooms@gmail.com + year: '2026' + doi: 10.32614/CRAN.package.xml2 +- type: software + title: askpass + abstract: 'askpass: Password Entry Utilities for R, Git, and SSH' + notes: Suggests + url: https://r-lib.r-universe.dev/askpass + repository: https://CRAN.R-project.org/package=askpass + authors: + - family-names: Ooms + given-names: Jeroen + email: jeroenooms@gmail.com + orcid: https://orcid.org/0000-0002-4035-0289 + year: '2026' + doi: 10.32614/CRAN.package.askpass +- type: software + title: htmltools + abstract: 'htmltools: Tools for HTML' + notes: Suggests + url: https://rstudio.github.io/htmltools/ + repository: https://CRAN.R-project.org/package=htmltools + authors: + - family-names: Cheng + given-names: Joe + email: joe@posit.co + - family-names: Sievert + given-names: Carson + email: carson@posit.co + orcid: https://orcid.org/0000-0002-4958-2844 + - family-names: Schloerke + given-names: Barret + email: barret@posit.co + orcid: https://orcid.org/0000-0001-9986-114X + - family-names: Chang + given-names: Winston + email: winston@posit.co + orcid: https://orcid.org/0000-0002-1576-2126 + - family-names: Xie + given-names: Yihui + email: yihui@posit.co + - family-names: Allen + given-names: Jeff + year: '2026' + doi: 10.32614/CRAN.package.htmltools +- type: software + title: keyring + abstract: 'keyring: Access the System Credential Store from R' + notes: Suggests + url: https://keyring.r-lib.org/ + repository: https://CRAN.R-project.org/package=keyring + authors: + - family-names: Csárdi + given-names: Gábor + email: csardi.gabor@gmail.com + year: '2026' + doi: 10.32614/CRAN.package.keyring +- type: software + title: knitr + abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R' + notes: Suggests + url: https://yihui.org/knitr/ + repository: https://CRAN.R-project.org/package=knitr + authors: + - family-names: Xie + given-names: Yihui + email: xie@yihui.name + orcid: https://orcid.org/0000-0003-0645-5666 + year: '2026' + doi: 10.32614/CRAN.package.knitr +- type: software + title: leaflet + abstract: 'leaflet: Create Interactive Web Maps with the JavaScript ''Leaflet'' + Library' + notes: Suggests + url: https://rstudio.github.io/leaflet/ + repository: https://CRAN.R-project.org/package=leaflet + authors: + - family-names: Cheng + given-names: Joe + email: joe@posit.co + - family-names: Schloerke + given-names: Barret + email: barret@posit.co + orcid: https://orcid.org/0000-0001-9986-114X + - family-names: Karambelkar + given-names: Bhaskar + - family-names: Xie + given-names: Yihui + - family-names: Aden-Buie + given-names: Garrick + email: garrick@posit.co + orcid: https://orcid.org/0000-0002-7111-0077 + year: '2026' + doi: 10.32614/CRAN.package.leaflet +- type: software + title: rhdf5 + abstract: 'rhdf5: R Interface to HDF5' + notes: Suggests + url: https://github.com/Huber-group-EMBL/rhdf5 + repository: https://bioconductor.org/ + authors: + - family-names: Fischer + given-names: Bernd + - family-names: Smith + given-names: Mike + email: mike.smith@embl.de + orcid: https://orcid.org/0000-0002-7800-3848 + - family-names: Pau + given-names: Gregoire + year: '2026' + doi: 10.18129/B9.bioc.rhdf5 +- type: software + title: rnaturalearth + abstract: 'rnaturalearth: World Map Data from Natural Earth' + notes: Suggests + url: https://docs.ropensci.org/rnaturalearth/ + repository: https://CRAN.R-project.org/package=rnaturalearth + authors: + - family-names: Massicotte + given-names: Philippe + email: pmassicotte@hotmail.com + orcid: https://orcid.org/0000-0002-5919-4116 + - family-names: South + given-names: Andy + email: southandy@gmail.com + year: '2026' + doi: 10.32614/CRAN.package.rnaturalearth +- type: software + title: rnaturalearthdata + abstract: 'rnaturalearthdata: World Vector Map Data from Natural Earth Used in ''rnaturalearth''' + notes: Suggests + url: https://docs.ropensci.org/rnaturalearthdata/ + repository: https://CRAN.R-project.org/package=rnaturalearthdata + authors: + - family-names: South + given-names: Andy + email: southandy@gmail.com + orcid: https://orcid.org/0000-0003-4051-6135 + - family-names: Michael + given-names: Schramm + email: mpschramm@gmail.com + - family-names: Massicotte + given-names: Philippe + email: pmassicotte@hotmail.com + orcid: https://orcid.org/0000-0002-5919-4116 + year: '2026' + doi: 10.32614/CRAN.package.rnaturalearthdata +- type: software + title: sf + abstract: 'sf: Simple Features for R' + notes: Suggests + url: https://r-spatial.github.io/sf/ + repository: https://CRAN.R-project.org/package=sf + authors: + - family-names: Pebesma + given-names: Edzer + email: edzer.pebesma@uni-muenster.de + orcid: https://orcid.org/0000-0001-8049-7069 + year: '2026' + doi: 10.32614/CRAN.package.sf +- type: software + title: testthat + abstract: 'testthat: Unit Testing for R' + notes: Suggests + url: https://testthat.r-lib.org + repository: https://CRAN.R-project.org/package=testthat + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + year: '2026' + doi: 10.32614/CRAN.package.testthat + version: '>= 3.0.0' +- type: software + title: tidyr + abstract: 'tidyr: Tidy Messy Data' + notes: Suggests + url: https://tidyr.tidyverse.org + repository: https://CRAN.R-project.org/package=tidyr + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + - family-names: Vaughan + given-names: Davis + email: davis@posit.co + - family-names: Girlich + given-names: Maximilian + year: '2026' + doi: 10.32614/CRAN.package.tidyr +- type: software + title: vol2birdR + abstract: 'vol2birdR: Vertical Profiles of Biological Signals in Weather Radar Data' + notes: Suggests + url: https://github.com/adokter/vol2birdR/ + repository: https://CRAN.R-project.org/package=vol2birdR + authors: + - family-names: Henja + given-names: Anders + email: anders.henja@gmail.com + - family-names: Dokter + given-names: Adriaan M. + email: vol2birdr@cornell.edu + orcid: https://orcid.org/0000-0001-6573-066X + year: '2026' + doi: 10.32614/CRAN.package.vol2birdR diff --git a/DESCRIPTION b/DESCRIPTION index c025fd2..23b3d96 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -65,8 +65,8 @@ VignetteBuilder: Config/testthat/edition: 3 Encoding: UTF-8 Roxygen: list(markdown = TRUE) -RoxygenNote: 7.3.2 Config/Needs/website: rmarkdown, leafpop, htmltools +Config/roxygen2/version: 8.0.0 diff --git a/R/get_vpts_aloft.R b/R/get_vpts_aloft.R index 29a51b5..32e7eb1 100644 --- a/R/get_vpts_aloft.R +++ b/R/get_vpts_aloft.R @@ -25,7 +25,7 @@ #' @param coverage A data frame containing the coverage of the Aloft bucket. #' If not provided, it will be fetched from via the internet. #' @return A tibble with VPTS data. -#' @keywords internal +#' @noRd get_vpts_aloft <- function( radar_odim_code, rounded_interval, diff --git a/R/get_vpts_rmi.R b/R/get_vpts_rmi.R index 6dc2a0b..f6a053e 100644 --- a/R/get_vpts_rmi.R +++ b/R/get_vpts_rmi.R @@ -5,7 +5,7 @@ #' #' @inheritParams get_vpts_aloft #' @return A tibble with VPTS data. -#' @keywords internal +#' @noRd get_vpts_rmi <- function(radar_odim_code, rounded_interval) { # Check the coverage for data availability diff --git a/R/get_weather_radars.R b/R/get_weather_radars.R index 14051ae..1b7ed82 100644 --- a/R/get_weather_radars.R +++ b/R/get_weather_radars.R @@ -15,9 +15,11 @@ #' from. #' - For `nexrad`: [nexrad-stations.txt](https://www.ncei.noaa.gov/access/homr/file/nexrad-stations.txt). #' -#' @inheritParams req_cache_getrad #' @param source Source of the metadata. `"opera"`, `"nexrad"` or `"all"`. #' If not provided, `"opera"` is used. +#' @param 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. #' @param ... Additional arguments passed on to reading functions per source, #' currently not used. #' @return A sf or tibble with weather radar metadata. In all cases the column `source` is diff --git a/R/utils.R b/R/utils.R index c765c5b..6d573c0 100644 --- a/R/utils.R +++ b/R/utils.R @@ -183,7 +183,6 @@ radar_to_name <- function(vpts_df_list) { #' #' @param x Character vector. #' @return An integer vector. -#' @seealso [as_numeric_shh()] [as_logical_shh()] #' @noRd #' @examples #' as_integer_shh(c("1", "2", "3")) @@ -278,11 +277,9 @@ req_retry_getrad <- function( #' #' @inheritParams httr2::req_cache #' @param req `httr2` request. -#' @param 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. +#' @inheritParams get_weather_radars use_cache #' @param ... Additional arguments passed to `httr2::req_cache()`. -#' @keywords internal +#' @noRd req_cache_getrad <- function( req, use_cache = TRUE, diff --git a/R/utils_pvol.R b/R/utils_pvol.R index dc7ff83..ab7ad82 100644 --- a/R/utils_pvol.R +++ b/R/utils_pvol.R @@ -5,7 +5,7 @@ #' #' @param urls A character vector with urls to h5 files to read #' @param ... arguments to bioRad::read_pvolfile -#' @param call +#' @inheritParams radar_recode call #' #' @returns a pvol #' @noRd diff --git a/man/getRad-package.Rd b/man/getRad-package.Rd index 0c0c6c5..786d872 100644 --- a/man/getRad-package.Rd +++ b/man/getRad-package.Rd @@ -18,21 +18,22 @@ Useful links: } \author{ -\strong{Maintainer}: Bart Kranstauber \email{b.kranstauber@uva.nl} (\href{https://orcid.org/0000-0001-8303-780X}{ORCID}) (University of Amsterdam) +\strong{Maintainer}: Bart Kranstauber \email{b.kranstauber@uva.nl} (\href{https://orcid.org/0000-0001-8303-780X}{ORCID}) (affiliation: University of Amsterdam) Authors: \itemize{ - \item Pieter Huybrechts \email{pieter.huybrechts@inbo.be} (\href{https://orcid.org/0000-0002-6658-6062}{ORCID}) (Research Institute for Nature and Forest (INBO)) - \item Peter Desmet \email{peter.desmet@inbo.be} (\href{https://orcid.org/0000-0002-8442-8025}{ORCID}) (Research Institute for Nature and Forest (INBO)) + \item Bart Kranstauber \email{b.kranstauber@uva.nl} (\href{https://orcid.org/0000-0001-8303-780X}{ORCID}) (affiliation: University of Amsterdam) + \item Pieter Huybrechts \email{pieter.huybrechts@inbo.be} (\href{https://orcid.org/0000-0002-6658-6062}{ORCID}) (affiliation: Research Institute for Nature and Forest (INBO)) + \item Peter Desmet \email{peter.desmet@inbo.be} (\href{https://orcid.org/0000-0002-8442-8025}{ORCID}) (affiliation: Research Institute for Nature and Forest (INBO)) } Other contributors: \itemize{ - \item Cecilia Nilsson \email{cecilia.nilsson@biol.lu.se} (\href{https://orcid.org/0000-0001-8957-4411}{ORCID}) (Lund University) [contributor] - \item Alexander Tedeschi \email{at744@cornell.edu} (\href{https://orcid.org/0000-0003-0772-6931}{ORCID}) (Cornell Lab of Ornithology) [contributor] - \item Hidde Leijnse (\href{https://orcid.org/0000-0001-7835-4480}{ORCID}) (Royal Netherlands Meteorological Institute) [contributor] - \item Bart Hoekstra (\href{https://orcid.org/0000-0002-7085-3805}{ORCID}) (University of Amsterdam) [contributor] - \item University of Amsterdam (04dkp9463) [copyright holder] + \item Cecilia Nilsson \email{cecilia.nilsson@biol.lu.se} (\href{https://orcid.org/0000-0001-8957-4411}{ORCID}) (affiliation: Lund University) [contributor] + \item Alexander Tedeschi \email{at744@cornell.edu} (\href{https://orcid.org/0000-0003-0772-6931}{ORCID}) (affiliation: Cornell Lab of Ornithology) [contributor] + \item Hidde Leijnse (\href{https://orcid.org/0000-0001-7835-4480}{ORCID}) (affiliation: Royal Netherlands Meteorological Institute) [contributor] + \item Bart Hoekstra (\href{https://orcid.org/0000-0002-7085-3805}{ORCID}) (affiliation: University of Amsterdam) [contributor] + \item University of Amsterdam (\href{https://ror.org/04dkp9463}{ROR}) [copyright holder] \item Biodiversa+ (https://hirad.science/) [funder] } diff --git a/man/get_pvol.Rd b/man/get_pvol.Rd index 5e54b67..1960ec2 100644 --- a/man/get_pvol.Rd +++ b/man/get_pvol.Rd @@ -42,7 +42,7 @@ with the Terminal Doppler Weather Radar (TDWR) program can not be read. These ca be identified using the \code{stntype} column in \code{get_weather_radars("nexrad")}. } \examples{ -\dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (interactive()) withAutoprint(\{ # examplesIf} # Get PVOL data for a single radar and datetime get_pvol("deess", as.POSIXct(Sys.Date())) diff --git a/man/get_vpts.Rd b/man/get_vpts.Rd index dd6512a..ef77d42 100644 --- a/man/get_vpts.Rd +++ b/man/get_vpts.Rd @@ -34,7 +34,7 @@ see details for an explanation of the file format.} \item{return_type}{Type of object that should be returned. Either: \itemize{ \item \code{"vpts"}: vpts object(s) (default). -\item \code{"tibble"}: a \code{\link[dplyr:reexports]{dplyr::tibble()}}. +\item \code{"tibble"}: a \code{\link[dplyr:tibble]{dplyr::tibble()}}. }} } \value{ @@ -44,7 +44,7 @@ Either a vpts object, a list of vpts objects or a tibble. See \description{ Gets vertical profile time series data from supported sources and returns it as a (list of) of \link[bioRad:summary.vpts]{vpts objects} or a -\code{\link[dplyr:reexports]{dplyr::tibble()}}. +\code{\link[dplyr:tibble]{dplyr::tibble()}}. } \details{ For more details on supported sources, see \code{vignette("supported_sources")}. @@ -68,7 +68,7 @@ data is stored in aloft data Besides the examples above there is a \code{date} object available for formatting. } \examples{ -\dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (interactive()) withAutoprint(\{ # examplesIf} # 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") diff --git a/man/get_vpts_aloft.Rd b/man/get_vpts_aloft.Rd deleted file mode 100644 index 3245158..0000000 --- a/man/get_vpts_aloft.Rd +++ /dev/null @@ -1,47 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/get_vpts_aloft.R -\name{get_vpts_aloft} -\alias{get_vpts_aloft} -\title{Get 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{ -\item{radar_odim_code}{Radar ODIM code.} - -\item{rounded_interval}{Interval to fetch data for, rounded to nearest day.} - -\item{source}{Source of the data. One of \code{baltrad}, \code{uva} or \code{ecog-04003}.} - -\item{coverage}{A data frame containing the coverage of the Aloft bucket. -If not provided, it will be fetched from via the internet.} -} -\value{ -A tibble with VPTS data. -} -\description{ -Gets VPTS data from the Aloft bucket. -} -\details{ -By default, data from the \href{https://aloftdata.eu/browse/}{Aloft bucket} are -retrieved from \url{https://aloftdata.s3-eu-west-1.amazonaws.com}. This can be changed by -setting \code{options(getRad.aloft_data_url)} to any desired url. -} -\section{Inner working}{ - -\itemize{ -\item Constructs the S3 paths for the VPTS files based on the input. -\item Performs parallel HTTP requests to fetch the VPTS CSV data. -\item Parses the response bodies with some assumptions about the column classes. -\item Adds a column with the radar source. -\item Overwrites the radar column with the radar_odim_code, all other values for -this column are considered in error. -} -} - -\keyword{internal} diff --git a/man/get_vpts_coverage.Rd b/man/get_vpts_coverage.Rd index af8087e..c4ab958 100644 --- a/man/get_vpts_coverage.Rd +++ b/man/get_vpts_coverage.Rd @@ -22,7 +22,7 @@ A \code{data.frame} or \code{tibble} with at least three columns, \code{source}, Gets the VPTS file coverage from supported sources per radar and date. } \examples{ -\dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (interactive()) withAutoprint(\{ # examplesIf} get_vpts_coverage() \dontshow{\}) # examplesIf} } diff --git a/man/get_vpts_rmi.Rd b/man/get_vpts_rmi.Rd deleted file mode 100644 index 6854ac6..0000000 --- a/man/get_vpts_rmi.Rd +++ /dev/null @@ -1,20 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/get_vpts_rmi.R -\name{get_vpts_rmi} -\alias{get_vpts_rmi} -\title{Get VPTS data from RMI} -\usage{ -get_vpts_rmi(radar_odim_code, rounded_interval) -} -\arguments{ -\item{radar_odim_code}{Radar ODIM code.} - -\item{rounded_interval}{Interval to fetch data for, rounded to nearest day.} -} -\value{ -A tibble with VPTS data. -} -\description{ -Get VPTS data from \href{https://opendata.meteo.be/geonetwork/srv/eng/catalog.search#/metadata/RMI_DATASET_CROW}{RMI_DATASET_CROW}. -} -\keyword{internal} diff --git a/man/get_weather_radars.Rd b/man/get_weather_radars.Rd index ae12c98..81d352d 100644 --- a/man/get_weather_radars.Rd +++ b/man/get_weather_radars.Rd @@ -37,7 +37,7 @@ from. } } \examples{ -\dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (interactive()) withAutoprint(\{ # examplesIf} # Get radar metadata from OPERA get_weather_radars(source = "opera") diff --git a/man/req_cache_getrad.Rd b/man/req_cache_getrad.Rd deleted file mode 100644 index 90a4b5a..0000000 --- a/man/req_cache_getrad.Rd +++ /dev/null @@ -1,40 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils.R -\name{req_cache_getrad} -\alias{req_cache_getrad} -\title{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{ -\item{req}{\code{httr2} request.} - -\item{use_cache}{Logical indicating whether to use the cache. Default is -\code{TRUE}. If \code{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.} - -\item{max_n, max_age, max_size}{Automatically prune the cache by specifying -one or more of: -\itemize{ -\item \code{max_age}: to delete files older than this number of seconds. -\item \code{max_n}: to delete files (from oldest to newest) to preserve at -most this many files. -\item \code{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.} - -\item{...}{Additional arguments passed to \code{httr2::req_cache()}.} -} -\description{ -Function to set the cache for a getRad specific httr2 request -} -\keyword{internal}