small documentation edits, fix test list_vpts_aloft

adokter · Sep 13, 2024 · 31e6d27 · 31e6d27
1 parent d44c92a
commit 31e6d27
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 17 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -66,6 +66,6 @@ Suggests:
 LazyData: true
 Encoding: UTF-8
 VignetteBuilder: knitr
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2
 Roxygen: list(markdown = TRUE)
 Config/testthat/edition: 3
diff --git a/R/calculate_param.R b/R/calculate_param.R
@@ -21,10 +21,10 @@
 #' vectorized. For example the `base` `ifelse` function is not vectorized,
 #' in these cases alternatives can be used (e.g. `dplyr::if_else`).
 #'
-#' Next some times functions do not operate on a `matrix` or `param` object.
-#' One example is the `dplyr::if_else` function, this can be resolved by
-#' calling the `c` function on a parameter to convert it to a vector
-#' (e.g. `c(DBZH)`).
+#' Also note that some functions do not operate on a `matrix` or `param` object.
+#' One example is the `dplyr::if_else` function. A workaround is
+#' calling the `c()` function on a parameter to convert it to a vector
+#' (e.g. `c(DBZH)`, see examples).
 #'
 #' @seealso
 #' * [get_param()]
@@ -52,6 +52,8 @@
 #' calculate_param(example_scan, DR = 10 * log10((ZDR + 1 - 2 * ZDR^0.5 * RHOHV) /
 #'   (ZDR + 1 + 2 * ZDR^0.5 * RHOHV)))
 #'
+#' # set all reflectivity  values to NA when correlation coefficient > 0.95
+#' (indicating precipitation)
 #' if (require(dplyr, quietly = TRUE)) {
 #'   calculate_param(pvol,
 #'     DBZH=if_else(c(RHOHV)>.95, NA, c(DBZH)) )

diff --git a/man/beam_distance.Rd b/man/beam_distance.Rd
diff --git a/man/beam_height.Rd b/man/beam_height.Rd
diff --git a/man/beam_range.Rd b/man/beam_range.Rd
diff --git a/man/beam_width.Rd b/man/beam_width.Rd
diff --git a/man/calculate_param.Rd b/man/calculate_param.Rd
diff --git a/man/gaussian_beam_profile.Rd b/man/gaussian_beam_profile.Rd
diff --git a/tests/testthat/test-list_vpts_aloft.R b/tests/testthat/test-list_vpts_aloft.R
@@ -116,11 +116,11 @@ test_that("list_vpts_aloft() warns if data was found for subset of radars or if
   )
   expect_warning(
     list_vpts_aloft(
-      date_min = "1900-01-01",
-      date_max = "2023-05-22",
+      date_min = "2020-01-01",
+      date_max = "2020-06-01",
       radars = c("nobml")
     ),
-    "Radar data found between 2023-02 and 2023-05 but not every date has radar data")
+    "Radar data found between 2020-02 and 2020-06 but not every date has radar data")
 })
 
 test_that("list_vpts_aloft() warns and returns emtpy vector on no data found",{