revised man for cwd()

geco-bern · Dec 5, 2024 · 28640aa · 28640aa
1 parent 7965859
commit 28640aa
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 9 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -32,7 +32,7 @@ Suggests:
     visdat,
     recipes
 License: AGPL-3
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
 Roxygen: list(markdown = TRUE)
 VignetteBuilder: knitr
 ByteCompile: true
diff --git a/R/cwd.R b/R/cwd.R
@@ -13,7 +13,8 @@
 #' during the same event, to which a CWD has to be reduced to terminate the event. Defaults to 0,
 #' meaning that the CWD has to be fully compensated by water infiltration into the soil to terminate
 #' a CWD event.
-#' @param thresh_terminate_absolute threshold determining end of event, as \code{thresh_terminate} but in absolute terms (in mm d-1).
+#' @param thresh_terminate_absolute threshold determining end of event, as \code{thresh_terminate} but in absolute terms
+#'(in the same units as \code{varname_wbal} is provided in).
 #' @param thresh_drop Level, relative to the CWD maximum of the same event, after which all data
 #' during the remainder of the event is set to missing values. This is to avoid interpreting data
 #' after rain events but before full compensation of CWD. Defaults to 0.9.

diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -1,8 +1,8 @@
-pandoc: 3.1.13
+pandoc: '3.2'
 pkgdown: 2.0.9
 pkgdown_sha: ~
 articles:
   cwd_example: cwd_example.html
   potential_cwd: potential_cwd.html
-last_built: 2024-05-13T13:11Z
+last_built: 2024-12-05T14:52Z
 
diff --git a/docs/reference/cwd.html b/docs/reference/cwd.html
diff --git a/man/cwd.Rd b/man/cwd.Rd