R/sum_Redds.R

In ryankinzer/cuyem: Snake River Basin Anadromous Fish Summaries and Metric Estimation

#' @title Sum Redd Counts
#'
#' @description Summarize CDMS redd count data.
#'
#' @param redd_data cleaned redd data
#' @param ... grouping variables
#'
#' @author Ryan N. Kinzer
#' @import dplyr
#' @return
#' @export
#'
#' @examples
#' redd_df <- cdmsR::getDatasetView(datastoreID = 78)
#' redd_dat <- clean_ReddData(redd_df)
#' sum_Redds(redd_dat, SurveyYear, StreamName, TransectName)
sum_Redds <- function(.redd_data, ...){

  {if(is.null(.redd_data)) stop('must supply redd dataset')}
  redd_dat <- .redd_data

  # get redd nums
  dat <- redd_dat %>%
    filter(WPTType == 'New Redd') %>%
    #distinct(ActivityId, .keep_all = TRUE) %>%
    group_by(...) %>%
    summarise(Redds = sum(Count, na.rm = FALSE))

  return(dat)
}