update readme

poissonconsulting · Jul 8, 2024 · 0773d88 · 0773d88
1 parent 86b6deb
commit 0773d88
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -38,6 +38,7 @@ Imports:
 Suggests:
     ggplot2,
     knitr,
+    latex2exp,
     rmarkdown,
     scales,
     testthat (>= 3.0.0)

diff --git a/README.Rmd b/README.Rmd
@@ -69,6 +69,15 @@ gss(gsdd::temperature_data)
 gss_plot(gsdd::temperature_data)
 ```
 
+### ATUs
+
+`date_atus` calculates the date on which a specified number of accumulated thermal units are exceeded.
+
+```{r}
+date_atus(gsdd::temperature_data, start_date = as.Date("1972-06-15"), atus = 600)
+```
+
+
 ## Contribution
 
 Please report any [issues](https://github.com/poissonconsulting/teckfish/issues).

diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
+
 <!-- badges: start -->
 
 [![Lifecycle:
@@ -75,6 +76,21 @@ gss_plot(gsdd::temperature_data)
 
 ![](man/figures/README-unnamed-chunk-5-1.png)<!-- -->
 
+### ATUs
+
+`date_atus` calculates the date on which a specified number of
+accumulated thermal units are exceeded.
+
+``` r
+date_atus(gsdd::temperature_data, start_date = as.Date("1972-06-15"), atus = 600)
+#> # A tibble: 2 × 4
+#> # Groups:   year [2]
+#>    year start_date end_date    atus
+#>   <int> <date>     <date>     <dbl>
+#> 1  2018 1971-06-15 NA           NA 
+#> 2  2019 1971-06-15 1971-07-09  613.
+```
+
 ## Contribution
 
 Please report any