diff --git a/404.html b/404.html index 6327c64..38baa26 100644 --- a/404.html +++ b/404.html @@ -24,7 +24,7 @@ teckfish - 0.1.1 + 0.2.0 + + + + + +
+
+
+

Calculate Growing Degree Days (GDD)

+ Source: R/gdd.R +
gdd.Rd
+
+ +
+

A wrapper on gsdd::gdd() to get the Growing Degree Days up to a date for +the longest growing season.

+
+ +
+

Usage

+ 
gdd(
+  x,
+  end_date = as.Date("1972-09-30"),
+  ignore_truncation = FALSE,
+  min_length = NULL,
+  msgs = TRUE
+)
+
+ +
+

Arguments

+
x
+

A data frame with two columns date and temperature. +date, which must be of class Date provides the dates and +temperature which must be a numeric vector provides the +mean daily water temperature in degrees centigrade.

+ + +
end_date
+

A Date scalar of the last date +within each year to consider (the year is ignored).

+ + +
ignore_truncation
+

A flag specifying whether to ignore start truncation (end truncation is always ignored).

+ + +
min_length
+

A whole number of the minimum length to consider. +Must be at least twice the window width but no more than 365. +If NULL then set to be the difference between start_date and end_date +(ignoring the year).

+ + +
msgs
+

A flag specifying whether to provide messages.

+ +
+
+

See also

+

gsdd::gdd() and gsdd().

+
+ +
+

Examples

+ 
gdd(gsdd::temperature_data)
+#> # A tibble: 1 × 2
+#>    year   gdd
+#>   <int> <dbl>
+#> 1  2019 3605.
+
+
+
+ + +
+ + + + + + + diff --git a/reference/gsdd.html b/reference/gsdd.html new file mode 100644 index 0000000..a45502f --- /dev/null +++ b/reference/gsdd.html @@ -0,0 +1,126 @@ + +Calculate Growing Season Degree Days (GSDD) — gsdd • teckfish + Skip to contents + + +
+
+
+

Calculate Growing Season Degree Days (GSDD)

+ Source: R/gsdd.R +
gsdd.Rd
+
+ +
+

A wrapper on gsdd::gsdd() to get the Growing Season Degree Days for +the longest growing season.

+
+ +
+

Usage

+ 
gsdd(x, ignore_truncation = FALSE, min_length = 274, msgs = TRUE)
+
+ +
+

Arguments

+
x
+

A data frame with two columns date and temperature. +date, which must be of class Date provides the dates and +temperature which must be a numeric vector provides the +mean daily water temperature in degrees centigrade.

+ + +
ignore_truncation
+

A flag specifying whether to ignore truncation +of the mean daily water temperature vector +or a string of "start", "end", "none" (equivalent to FALSE) or "both" +(equivalent to TRUE) specifying which type of truncation to ignore.

+ + +
min_length
+

A whole number of the minimum length to consider. +Must be at least twice the window width but no more than 365. +If NULL then set to be the difference between start_date and end_date +(ignoring the year).

+ + +
msgs
+

A flag specifying whether to provide messages.

+ +
+
+

See also

+

gsdd::gsdd(), gdd() and gsdd_vctr().

+
+ +
+

Examples

+ 
gsdd(gsdd::temperature_data)
+#> # A tibble: 1 × 2
+#>    year  gsdd
+#>   <int> <dbl>
+#> 1  2019 3899.
+
+
+
+ + +
+ + + + + + + diff --git a/reference/gsdd_cf.html b/reference/gsdd_cf.html index cce8784..8e2ef89 100644 --- a/reference/gsdd_cf.html +++ b/reference/gsdd_cf.html @@ -1,17 +1,5 @@ -Calculate Growing Season Degree Days (GSDD) — gsdd_cf • teckfishCalculate Growing Season Degree Days (GSDD) — gsdd_cf • teckfish @@ -22,7 +10,7 @@ teckfish - 0.1.1 + 0.2.0 + + + + + +
+
+
+

Calculate Growing Season Degree Days (GSDD) from a vector

+ Source: R/gsdd-vctr.R +
gsdd_vctr.Rd
+
+ +
+

A wrapper on gsdd::gsdd_vctr() to get the Growing Season Degree Days +for a vector for the longest growing season.

+
+ +
+

Usage

+ 
gsdd_vctr(x, ignore_truncation = FALSE, min_length = 274, msgs = TRUE)
+
+ +
+

Arguments

+
x
+

A numeric vector of the +mean daily water temperature values for the period +of interest in C.

+ + +
ignore_truncation
+

A flag specifying whether to ignore truncation +of the mean daily water temperature vector +or a string of "start", "end", "none" (equivalent to FALSE) or "both" +(equivalent to TRUE) specifying which type of truncation to ignore.

+ + +
min_length
+

A whole number of the minimum length to consider. +Must be at least twice the window width but no more than 365. +If NULL then set to be the difference between start_date and end_date +(ignoring the year).

+ + +
msgs
+

A flag specifying whether to provide messages.

+ +
+
+

Value

+ + +

A non-negative real number of the GSDD.

+
+
+

See also

+

gsdd::gsdd_vctr() and gsdd().

+
+ +
+

Examples

+ 
gsdd_vctr(c(rep(1, 10), rep(10, 20), rep(1, 200)))
+#> `The length of `x` must be at least 274.
+#> [1] NA
+gsdd_vctr(gsdd::temperature_data$temperature)
+#> [1] 3898.806
+
+
+
+ + +
+ + + + + + + diff --git a/reference/index.html b/reference/index.html index 96481c9..6570a7a 100644 --- a/reference/index.html +++ b/reference/index.html @@ -10,7 +10,7 @@ teckfish - 0.1.1 + 0.2.0