update documentation fix #178

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

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,

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

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

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,

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