R/tweaked_functions.R

In joelgsponer/waRRior2: waRRior

#' No NA -Inf Max
#' Returns a max value ignoring NAs while calculating the max and replacing
#' -Inf with NA (which occurs if the max is taken from only NA vales while
#' setting na.rm = T)
#' @param x A vector
#'
#' @return Either a Number of NA
#' @export
#'
#' @examples
#' max_noNA_noInf(c(1,2))
#' max_noNA_noInf(c(NA,1))
#' max_noNA_noInf(c(NA,NA))
max_noNA_noInf <- function(x){
  res <- suppressWarnings(max(x, na.rm=T))
  res <- dplyr::if_else(res == -Inf | res == Inf, NA_real_, res)
  return(res)
}
# -------------------------------------------------------------------
#' No NA -Inf Mean
#' Returns a mean value ignoring NAs while calculating the mean and replacing
#' -Inf with NA (which occurs if the mean is taken from only NA vales while
#' setting na.rm = T)
#' @param x A vector
#'
#' @return Either a Number of NA
#' @export
#'
#' @examples
#' mean_noNA_noInf(c(1,2))
#' mean_noNA_noInf(c(NA,1))
#' mean_noNA_noInf(c(NA,NA))
mean_noNA_noInf <- function(x){
  res <- suppressWarnings(mean(x, na.rm=T))
  res <- dplyr::if_else(res == -Inf | res == Inf, NA_real_, res)
  return(res)
}
# -------------------------------------------------------------------
#' No NA -Inf Min
#' Returns a min value ignoring NAs while calculating the min and replacing
#' -Inf with NA (which occurs if the min is taken from only NA vales while
#' setting na.rm = T)
#' @param x A vector
#'
#' @return Either a Number of NA
#' @export
#'
#' @examples
#' min_noNA_noInf(c(1,2))
#' min_noNA_noInf(c(NA,1))
#' min_noNA_noInf(c(NA,NA))
min_noNA_noInf <- function(x){
  res <- suppressWarnings(min(x, na.rm=T))
  res <- dplyr::if_else(res == -Inf | res == Inf, NA_real_, res)
  return(res)
}
# -----------------------------------------------------------------------------
#' No NA -Inf sd
#' Returns a sd value ignoring NAs while calculating the sd and replacing
#' -Inf with NA (which occurs if the sd is taken from only NA vales while
#' setting na.rm = T)
#' @param x A vector
#'
#' @return Either a Number of NA
#' @export
#'
#' @examples
#' sd_noNA_noInf(c(NA,1))
#' sd_noNA_noInf(c(NA,NA))
sd_noNA_noInf <- function(x){
  res <- suppressWarnings(stats::sd(x, na.rm=T))
  res <- dplyr::if_else(res == -Inf | res == Inf, NA_real_, res)
  return(res)
}
# -----------------------------------------------------------------------------
#' No NA -Inf median
#' Returns a median value ignoring NAs while calculating the median and replacing
#' -Inf with NA (which occurs if the median is taken from only NA vales while
#' setting na.rm = T)
#' @param x A vector
#'
#' @return Either a Number of NA
#' @export
#'
#' @examples
#' median_noNA_noInf(c(NA,1))
#' median_noNA_noInf(c(NA,NA))
median_noNA_noInf <- function(x){
  res <- suppressWarnings(stats::median(x, na.rm=T))
  res <- as.numeric(res)
  res <- dplyr::if_else(res == -Inf | res == Inf, NA_real_, res)
  return(res)
}
# -----------------------------------------------------------------------------
#' Sum units
#' Takes a vector of units and sums them and returns a new unit vector with
#' the same units.
#' @param x Unit vector
#'
#' @return Sum as a unit
#' @export
#'
#' @examples
#' library(ggplot2)
#' x <- unit(c(1,2,3,4), units = "cm")
#' sum_units(x)
sum_units <- function(x) {
  u <- attr(x, "unit")
  x <- as.numeric(x)
  x <- sum(x)
  return(ggplot2::unit(x, units = u))
}