#' Function to return the RA3 hydrologic indicator statistic for a given data frame
#'
#' This function accepts a data frame that contains a column named "discharge" and
#' calculates the mean of the fall rate for the entire record
#'
#' @param qfiletempf data frame containing a "discharge" column containing daily flow values
#' @param pref string containing a "mean" or "median" preference
#' @return ra3 numeric containing the mean of the fall rate for the given data frame
#' @export
#' @examples
#' load_data<-paste(system.file(package="HITHATStats"),"/data/obs_data.csv",sep="")
#' qfiletempf<-read.csv(load_data)
#' ra3(qfiletempf)
ra3 <- function(qfiletempf, pref = "mean") {
diffbtdays <- diff(qfiletempf$discharge, lag = 1,
differences = 1)
findfallvalueneg <- subset(diffbtdays, diffbtdays <
0)
findfallvalues <- abs(findfallvalueneg)
if (pref == "median") {
ra3 <- median(findfallvalues)
}
else {
ra3 <- mean(findfallvalues)
}
return(ra3)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.