R/cut_by_quantile.r

In vbfelix/relper: Miscellaneous Functions for Data Preparation, Cleaning, and Visualization

#' Convert numeric vector to factor, using quantiles intervals
#'
#' @description Divides the range of a numeric vector by the quantiles provided ('q').
#'
#' @eval arg_vector("x","numeric")
#' @eval arg_vector("q","numeric")
#'
#' @return A factor vector with the interval range of the quantiles.
#'
#' @export
#'
#' @examples
#'
#' x <- rnorm(10)
#'
#' cut_by_quantile(x)
#'


cut_by_quantile <- function(x, q = seq(0,1,by = .20)) {

  stopifnot(is.numeric(x), length(x) > 1)

  stopifnot(is.numeric(q), length(q) > 1, q >= 0 & q <= 1)

  cut(
    x = x,
    breaks = stats::quantile(x,probs = q,na.rm = TRUE),
    include.lowest = TRUE,
    right = TRUE
  )

}