R/lim.R

In obreschkow/cooltools: Practical Tools for Scientific Computations and Visualizations

#' Crop values to a custom range
#'
#' @description Limits the values of a vector or array to a desired interval, while keeping the shape of the input argument
#'
#' @param x vector or array
#' @param min minimum value
#' @param max maximum value
#' @param clip optional value specifying the value assigned to clipped data, e.g. \code{clip=NA}
#' @param na optional value specifying the value assigned to non-numbers (NA and NaN)
#'
#' @return vector/array of the same shape as \code{x}
#'
#' @author Danail Obreschkow
#'
#' @seealso \code{stretch}
#'
#' @export

lim = function(x, min=0, max=1, clip=NULL, na=NULL) {
  if (!is.null(clip)) s = x<min | x>max
  x[x<min] = min
  x[x>max] = max
  if (!is.null(clip)) x[s]=clip
  if (!is.null(na)) x[is.na(x)]=na
  return(x)
}