R/modulo.R

In toddellis/miao: Miao! Miauw! Miaow! Miaou! Mjau! Meow!

#' modulo
#'
#' Applies a modulo operation with a specified base resolution
#'
#' @param x Numeric vector to scale.
#' @param res Base resolution to scale x to using a modulo operation.
#'
#' @return Scaled vector.
#' @export
#'
#' @examples
#' runif(100, 0, 100) %>%
#'  tibble::as_tibble() %>%
#'  dplyr::mutate(mod = modulo(value, 15))
#'

modulo <- function(x,
                   res = 1,
                   center = TRUE) {

  output <-
    x - (x %% res)

  if (center) {
    output + (res / 2)
  } else {
    output
  }

}