- Added gss() function from gsdd package to calculate growing sea…

…sons.

DESCRIPTION

@@ -29,8 +29,8 @@ Depends:
 Imports: 
     chk,
     dplyr,
-    fishbc,
-    gsdd (>= 0.0.1),
+    fishbc (>= 0.2.1),
+    gsdd (>= 0.0.2),
     lifecycle,
     purrr,
     rlang,

NAMESPACE

@@ -5,6 +5,7 @@ export(freshwaterfish)
 export(gdd)
 export(gsdd)
 export(gsdd_cf)
+export(gss)
 export(interpolate_numeric_vector)
 import(chk)
 importFrom(fishbc,fbc_common_name)

R/gdd.R

@@ -4,7 +4,7 @@
 #' the longest growing season.
 #'
 #' @inheritParams gsdd::gdd
-#' @seealso [gsdd::gdd()] and [gsdd()].
+#' @seealso [gsdd::gdd()], [gsdd()] and [gss()].
 #' @export
 #'
 #' @examples

R/gsdd.R

@@ -4,7 +4,7 @@
 #' the longest growing season.
 #' 
 #' @inheritParams gsdd::gsdd
-#' @seealso [gsdd::gsdd()], [gdd()] and [gsdd_vctr()].
+#' @seealso [gsdd::gsdd()], [gsdd()] and [gss()].
 #' @export
 #'
 #' @examples

R/gss.R

@@ -0,0 +1,29 @@
+#' Calculate Growing Seasons (GSS)
+#' 
+#' A wrapper on [gsdd::gss()] to by default 
+#' get all Growing Seasons ignoring truncation.
+#' For more information see [gsdd::gss()].
+#'
+#' @inheritParams gsdd::gdd
+#' @seealso [gsdd::gss()], [gsdd()] and [gss()].
+#' @export
+#'
+#' @examples
+#' gss(gsdd::temperature_data)
+gss <- function(
+    x,
+    min_length = 120,
+    ignore_truncation = TRUE,
+    pick = "all",
+    msgs = TRUE
+) {
+  chk_whole_number(min_length)
+  chk_range(min_length, c(14, 274))
+
+  gsdd::gss(
+    x, 
+    min_length = min_length, 
+    ignore_truncation = ignore_truncation,
+    pick = pick,
+    msgs = msgs)
+}

tests/testthat/_snaps/gss.md

@@ -0,0 +1,44 @@
+# gss works
+
+    Code
+      gss
+    Output
+      # A tibble: 1 x 5
+      # Groups:   year [1]
+         year start_dayte end_dayte   gsdd truncation
+        <int> <date>      <date>     <dbl> <chr>     
+      1  2019 1971-03-20  1971-11-07 3899. none      
+
+# gss works t2
+
+    Code
+      gss
+    Output
+      # A tibble: 2 x 5
+      # Groups:   year [1]
+         year start_dayte end_dayte   gsdd truncation
+        <int> <date>      <date>     <dbl> <chr>     
+      1  2019 1971-04-08  1971-06-04   500 none      
+      2  2019 1971-07-15  1971-09-03   800 none      
+
+# gss truncation off
+
+    Code
+      gss
+    Output
+      # A tibble: 0 x 5
+      # i 5 variables: year <int>, start_dayte <date>, end_dayte <date>, gsdd <dbl>,
+      #   truncation <chr>
+
+# gss truncation on
+
+    Code
+      gss
+    Output
+      # A tibble: 2 x 5
+      # Groups:   year [1]
+         year start_dayte end_dayte   gsdd truncation
+        <int> <date>      <date>     <dbl> <chr>     
+      1  2019 1971-04-08  1971-06-04   500 none      
+      2  2019 1971-07-15  1971-11-30  1255 end       
+

tests/testthat/test-gss.R

@@ -0,0 +1,35 @@
+test_that("gss works", {
+  gss <- gss(gsdd::temperature_data)
+  expect_snapshot({
+    gss
+  })
+})
+
+test_that("gss works t2", {
+  data <- gsdd::temperature_data
+  data$temperature <- data$temperature2
+  gss <- gss(data)
+  expect_snapshot({
+    gss
+  })
+})
+
+test_that("gss truncation off", {
+  data <- gsdd::temperature_data
+  data$temperature <- data$temperature2
+  data$temperature[data$date >= as.Date("2019-08-28")] <- 5
+  gss <- gss(data, ignore_truncation = FALSE, msgs = FALSE)
+  expect_snapshot({
+    gss
+  })
+})
+
+test_that("gss truncation on", {
+  data <- gsdd::temperature_data
+  data$temperature <- data$temperature2
+  data$temperature[data$date >= as.Date("2019-08-28")] <- 5
+  gss <- gss(data)
+  expect_snapshot({
+    gss
+  })
+})