feat(write_stats)

fixes #52

DESCRIPTION

@@ -1,14 +1,14 @@
 Package: kostra2010R
 Title: R Interface for KOSTRA-DWD-2010r Dataset
-Version: 0.8.7
-Date: 2023-09-26
+Version: 0.9.0
+Date: 2024-02-28
 Authors@R: 
     person("Dimitri", "Falk", , "[email protected]", role = c("aut", "cre"))
 Description: Extract cell-specific precipitation statistics from KOSTRA-DWD-2010R.
 License: GPL (>= 3)
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 Depends: R (>= 4.2.0)
 Imports: 
     checkmate,

NAMESPACE

@@ -11,4 +11,5 @@ export(get_returnp)
 export(get_stats)
 export(idx_build)
 export(idx_exists)
+export(write_stats)
 import(sf)

NEWS.md

@@ -1,4 +1,4 @@
-# version 0.8.7
+# version 0.9.0
 
 ## features
 
@@ -9,6 +9,7 @@
 - `get_returnp()` now allows interpolation of return periods with `interpolate = TRUE`
 - `get_depth()` now allows to consider uncertainties with `uc = TRUE`
 - `get_stats()` now optionally return precipitation yield values with `as_depth = FALSE`
+- `write_stats()` now wraps `write.table()` to facilitate dumping stats to disk
 
 
 ## enhancements

R/write_stats.R

@@ -0,0 +1,54 @@
+#' Write cell-specific statistics from the KOSTRA-DWD-2010R dataset to disk
+#'
+#' @param x Tibble containing grid cell statistics from KOSTRA-DWD-2010R,
+#'     as provided by `get_stats()`.
+#' @param file character. Filename with csv extension to be used for data output.
+#'
+#' @export
+#'
+#' @seealso \link{get_stats}
+#'
+#' @examples
+#' \dontrun{
+#' kostra <- get_stats("49011")
+#'
+#' write_stats(kostra)
+#' write_stats(kostra, file = tempfile(fileext = ".csv"))
+#' }
+write_stats <- function(x = NULL,
+                        file = NULL) {
+
+  # debugging ------------------------------------------------------------------
+
+  # x <- get_stats("49011")
+  # file <- "kostra2010R_hN_49011.csv"
+
+  # check arguments ------------------------------------------------------------
+
+  checkmate::assert_tibble(x)
+
+  checkmate::assert(
+
+    checkmate::test_null(file),
+    checkmate::test_character(file, len = 1, pattern = "csv$")
+  )
+
+  # main -----------------------------------------------------------------------
+
+  # construct default filename if not specified
+  if (is.null(file)) {
+
+    file <- paste0("kostra2010R_",
+                   attr(x, "type"), "_",
+                   attr(x, "id"), ".csv")
+  }
+
+  # dump to disk
+  utils::write.table(x,
+                     file,
+                     sep = "; ",
+                     dec = ",",
+                     na = "",
+                     row.names = FALSE,
+                     quote = FALSE)
+}

README.Rmd

@@ -235,7 +235,7 @@ ggplot(longdata, aes(D_min, value, colour = name)) +
           subtitle = paste0("INDEX_RC: ", attr(kostra, "id")))
 ```
 
-... or exported to disk using `write.csv2()`.
+... or exported to disk using `write_stats()`.
 
 ## Contributing
 

README.md

@@ -48,7 +48,7 @@ and load the package via
 
 ``` r
 library(kostra2010R)
-#> 0.8.7
+#> 0.9.0
 ```
 
 ## Getting started
@@ -115,9 +115,9 @@ p3
 #> Geometry set for 1 feature 
 #> Geometry type: POINT
 #> Dimension:     XY
-#> Bounding box:  xmin: 6.784479 ymin: 51.23912 xmax: 6.784479 ymax: 51.23912
+#> Bounding box:  xmin: 6.784486 ymin: 51.23912 xmax: 6.784486 ymax: 51.23912
 #> Geodetic CRS:  WGS 84
-#> POINT (6.784479 51.23912)
+#> POINT (6.784486 51.23912)
 
 p4 <- get_centroid("Freiburg im Breisgau")
 p4
@@ -387,7 +387,7 @@ ggplot(longdata, aes(D_min, value, colour = name)) +
 
 <img src="man/figures/README-unnamed-chunk-21-1.png" width="100%" />
 
-… or exported to disk using `write.csv2()`.
+… or exported to disk using `write_stats()`.
 
 ## Contributing
 

tests/testthat/test-write_stats.R

@@ -0,0 +1,32 @@
+test_that("Data I/O works", {
+
+  filename <- "kostra2010R_HN_49011.csv"
+
+  write_stats(kostra_ref)
+
+  kostra <- utils::read.table(file = filename,
+                              header = TRUE,
+                              sep = ";",
+                              dec = ",",
+                              na = "")
+
+  unlink(filename)
+
+  testthat::expect_equal(as.matrix(kostra),
+                         as.matrix(kostra_ref))
+
+
+
+  filename <- tempfile(fileext = ".csv")
+
+  write_stats(kostra_ref, file = filename)
+
+  kostra <- utils::read.table(file = filename,
+                              header = TRUE,
+                              sep = ";",
+                              dec = ",",
+                              na = "")
+
+  testthat::expect_equal(as.matrix(kostra),
+                         as.matrix(kostra_ref))
+})