Skip to content

Commit

Permalink
working on updated fib vignette for new entero functions
Browse files Browse the repository at this point in the history
  • Loading branch information
fawda123 committed Aug 2, 2024
1 parent 152812b commit a161e65
Show file tree
Hide file tree
Showing 6 changed files with 215 additions and 21 deletions.
2 changes: 1 addition & 1 deletion R/anlz_enteromap.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#' @param fibdata data frame of Enterococcus sample data as returned by \code{\link{enterodata}} or \code{\link{anlz_fibwetdry}}
#' @param yrsel optional numeric to filter data by year
#' @param mosel optional numeric to filter data by month
#' @param wetdry logical; if \code{TRUE}, incorporate wet/dry differences (this will result in a call to \code{\link{anlz_fibwetdry}}, in which case \code{temporal_window} and \code{wet_threshold} are required). if \code{FALSE} (default), do not differentiate between wet and dry samples.
#' @param wetdry logical; if \code{TRUE}, incorporate wet/dry differences (this will result in a call to \code{\link{anlz_fibwetdry}}, in which case \code{temporal_window} and \code{wet_threshold} are required). If \code{FALSE} (default), do not differentiate between wet and dry samples.
#' @param precipdata input data frame as returned by \code{\link{read_importrain}}. columns should be: station, date (yyyy-mm-dd), rain (in inches). The object \code{\link{catchprecip}} has this data from 1995-2023 for select Enterococcus stations. If \code{NULL}, defaults to \code{\link{catchprecip}}.
#' @param temporal_window numeric; required if \code{wetdry} is \code{TRUE}. number of days precipitation should be summed over (1 = day of sample only; 2 = day of sample + day before; etc.)
#' @param wet_threshold numeric; required if \code{wetdry} is \code{TRUE}. inches accumulated through the defined temporal window, above which a sample should be defined as being from a 'wet' time period
Expand Down
3 changes: 0 additions & 3 deletions R/show_enteromap.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,11 @@
#' @export
#'
#' @examples
#' \dontrun{
#' show_enteromap(enterodata, yrsel = 2020, mosel = 9)
#'
#' # wet/dry samples
#' show_enteromap(enterodata, yrsel = 2020, mosel = 9, wetdry = TRUE,
#' temporal_window = 2, wet_threshold = 0.5)
#' }

show_enteromap <- function(fibdata, yrsel, mosel, wetdry = FALSE,
precipdata = NULL, temporal_window = NULL,
wet_threshold = NULL){
Expand Down
2 changes: 1 addition & 1 deletion man/anlz_enteromap.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 1 addition & 3 deletions man/show_enteromap.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/show_fibmatrix.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit a161e65

Please sign in to comment.