-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
79 lines (56 loc) · 3 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
```
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://github.com/poissonconsulting/gsdd/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/poissonconsulting/gsdd)
[](https://opensource.org/license/mit/)
<!-- badges: end -->
# gsdd
## Introduction
`gsdd` is an R package to calculate Growing Season Degree Days (GSDD), Growing Degree Days (GDD) and Growing Seasons (GSS) from water temperature data.
GSSD is a water temperature metric that is a useful predictor of age-0 trout size at the beginning of winter.
It is the accumulated thermal units (in °C) during the growing season based on the mean daily water temperature values.
GDD is the GSSD to a particular date.
The GSDD is calculated across the longest consecutive sequence of non-missing values.
Truncation occurs when the start and/or end of the sequence of non-missing values is part way through a growing season.
If the user chooses to ignore truncation then the returned value(s) are very likely to be less than the actual value(s).
The default values and implementation of the growing season are based on Coleman and Fausch (2007) who stated that
> We defined the start of the growing season as the beginning of the first week that average stream temperatures exceeded and
remained above 5°C for the season; the end of the growing season was defined as the last day of the first week that average stream temperature dropped below 4°C.
For the purposes of the calculation week refers to a seven day rolling average as opposed to the calendar week.
If there are multiple growing 'seasons' within the same year then by default the returned value is the sum of the GSDD values for `"all"` seasons.
### Reference
Coleman, M.A., and Fausch, K.D. 2007. Cold Summer Temperature Limits Recruitment of Age-0 Cutthroat Trout in High-Elevation Colorado Streams. Transactions of the American Fisheries Society 136(5): 1231–1244. doi:10.1577/T05-244.1.
## Installation
```r
install.packages("remotes")
remotes::install_github("poissonconsulting/gsdd")
```
## Implementation
The `gssd` package provides functions to calculate the GSSD, GDD and GSS from water temperature data.
```{r}
library(gsdd)
data <- gsdd::temperature_data
gsdd(data)
gdd(data)
gss(data)
```
It also provides a function to plot water temperature data.
```{r}
gss_plot(data)
```
And to calculate GSDD from a vector.
```{r}
x <- gsdd::temperature_data$temperature
gsdd_vctr(x)
```