Convert NaN to NA in metric returns (#63)

ropensci · Apr 30, 2024 · 04d6dc0 · 04d6dc0
1 parent 14591d9
commit 04d6dc0
Show file tree

Hide file tree

Showing 10 changed files with 2,575 additions and 3,401 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,9 @@
 # waywiser (development version)
 
+* Metric functions now return `NA` in all cases where they previously returned `NaN`.
+  This improves cross-platform consistency; in particular, MacOS often returned 
+  `NA` when every other platform would return `NaN`. (#63)
+
 * `ww_multi_scale()` now handles classification and class probability metrics better 
   when called with raster arguments (either to `data` or to `truth` and `estimate`):
   * When called with classification metrics, `ww_multi_scale()` will now convert 

diff --git a/R/misc_yardstick.R b/R/misc_yardstick.R
@@ -35,6 +35,8 @@ yardstick_df <- function(data, truth, estimate, na_rm, name, metric_fun, ..., ca
     sf::st_geometry(out) <- NULL
   }
 
+  out[[".estimate"]][is.nan(out[[".estimate"]])] <- NA
+
   out
 }
 
@@ -198,7 +200,9 @@ yardstick_vec <- function(truth, estimate, na_rm, impl, wt = NULL, ..., case_wei
   if (length(truth) == 0) rlang::abort("0 non-missing values were passed to `truth`.")
   if (length(estimate) == 0) rlang::abort("0 non-missing values were passed to `estimate`.")
 
-  impl(truth = truth, estimate = estimate, ...)
+  out <- impl(truth = truth, estimate = estimate, ...)
+  out[is.nan(out)] <- NA
+  out
 }
 
 #' Workhorse function powering spatial yardstick metrics

diff --git a/tests/testthat/_snaps/srr-ww_global_geary_c.md b/tests/testthat/_snaps/srr-ww_global_geary_c.md
@@ -164,7 +164,7 @@
       ww_global_geary_c_vec(worldclim_simulation$response, worldclim_simulation$
         response, worldclim_weights)
     Output
-      [1] NaN
+      [1] NA
 
 ---
 
@@ -174,7 +174,7 @@
       # A tibble: 1 x 3
         .metric        .estimator .estimate
         <chr>          <chr>          <dbl>
-      1 global_geary_c standard         NaN
+      1 global_geary_c standard          NA
 
 # other generic srr standards
 

diff --git a/tests/testthat/_snaps/srr-ww_global_moran_i.md b/tests/testthat/_snaps/srr-ww_global_moran_i.md
@@ -164,7 +164,7 @@
       ww_global_moran_i_vec(worldclim_simulation$response, worldclim_simulation$
         response, worldclim_weights)
     Output
-      [1] NaN
+      [1] NA
 
 ---
 
@@ -174,7 +174,7 @@
       # A tibble: 1 x 3
         .metric        .estimator .estimate
         <chr>          <chr>          <dbl>
-      1 global_moran_i standard         NaN
+      1 global_moran_i standard          NA
 
 # other generic srr standards
 

diff --git a/tests/testthat/_snaps/srr-ww_local_geary_c.md b/tests/testthat/_snaps/srr-ww_local_geary_c.md
diff --git a/tests/testthat/_snaps/srr-ww_local_geary_pvalue.md b/tests/testthat/_snaps/srr-ww_local_geary_pvalue.md
diff --git a/tests/testthat/_snaps/srr-ww_local_getis_ord_g.md b/tests/testthat/_snaps/srr-ww_local_getis_ord_g.md
diff --git a/tests/testthat/_snaps/srr-ww_local_getis_ord_g_pvalue.md b/tests/testthat/_snaps/srr-ww_local_getis_ord_g_pvalue.md
diff --git a/tests/testthat/_snaps/srr-ww_local_moran_i.md b/tests/testthat/_snaps/srr-ww_local_moran_i.md
diff --git a/tests/testthat/_snaps/srr-ww_local_moran_pvalue.md b/tests/testthat/_snaps/srr-ww_local_moran_pvalue.md