Clean a few minor things (#814)

* improve message * fix typo in docs * add missing rdname tags to assert_forecast
epiforecasts · May 20, 2024 · 6aceaaa · 6aceaaa
1 parent 87adf45
commit 6aceaaa
Show file tree

Hide file tree

Showing 9 changed files with 19 additions and 7 deletions.
diff --git a/R/documentation-templates.R b/R/documentation-templates.R
@@ -51,7 +51,7 @@
 #' of the data belong together and jointly form a single forecasts. This is
 #' easy e.g. for point forecast, where there is one row per forecast. For
 #' quantile or sample-based forecasts, however, there are multiple rows that
-#' belong to single forecast.
+#' belong to a single forecast.
 #'
 #' The *forecast unit* or *unit of a single forecast* is then described by the
 #' combination of columns that uniquely identify a single forecast.

diff --git a/R/forecast.R b/R/forecast.R
@@ -196,6 +196,7 @@ assert_forecast <- function(
 
 
 #' @importFrom cli cli_abort
+#' @rdname assert_forecast
 #' @export
 #' @keywords check-forecasts
 assert_forecast.default <- function(
@@ -211,6 +212,7 @@ assert_forecast.default <- function(
 
 
 #' @export
+#' @rdname assert_forecast
 #' @importFrom cli cli_abort
 #' @keywords check-forecasts
 assert_forecast.forecast_binary <- function(
@@ -247,6 +249,7 @@ assert_forecast.forecast_binary <- function(
 
 
 #' @export
+#' @rdname assert_forecast
 #' @importFrom cli cli_abort
 #' @keywords check-forecasts
 assert_forecast.forecast_point <- function(

diff --git a/R/metrics-quantile.R b/R/metrics-quantile.R
@@ -445,7 +445,7 @@ bias_quantile <- function(observed, predicted, quantile_level, na.rm = TRUE) {
     #nolint start: keyword_quote_linter
     cli_inform(
       c(
-        "i" = "Median not available, computing bias as mean of the two
+        "i" = "Median not available, interpolating median from the two
         innermost quantiles in order to compute bias."
       )
     )

diff --git a/man/as_forecast.Rd b/man/as_forecast.Rd
diff --git a/man/assert_forecast.Rd b/man/assert_forecast.Rd
diff --git a/man/forecast_types.Rd b/man/forecast_types.Rd
diff --git a/man/get_forecast_unit.Rd b/man/get_forecast_unit.Rd
diff --git a/man/score.Rd b/man/score.Rd
diff --git a/tests/testthat/test-metrics-quantile.R b/tests/testthat/test-metrics-quantile.R
@@ -861,7 +861,7 @@ test_that("bias_quantile(): quantile levels must be unique", {
 test_that("bias_quantile only produces one message", {
   expect_message(
     bias_quantile(observed, predicted[, -3], quantile_level[-3]),
-    "Median not available, computing bias as mean of the two innermost quantiles in order to compute bias."
+    "Median not available, interpolating median from the two innermost quantiles in order to compute bias."
   )
 })