R/COUNTIF.R

In njbultman/xlsxFunctions: Use Common Microsoft Excel Functions in R

#' Count Vector Components Based On Condition
#'
#' Counts the amount of instances a condition is specified in a vector.
#'
#' @return Returns count in the condition vector based on the condition specified.
#' @author Nick Bultman, \email{njbultman74@@gmail.com}, September 2020
#' @seealso \code{\link{length}}
#' @keywords conditional count
#' @export
#' @examples
#' COUNTIF(iris$Species, "virginica")
#' COUNTIF(c(3, 1, 3), 3)
#'
#' @param condition_vector Vector that you would like condition specified for.
#' @param condition Value that will satisfy certain components in condition vector.
#'
COUNTIF <- function(condition_vector, condition) {

  y <- sum(condition_vector == condition)

  return(y)

}