R/discrete_by_quantile.R

Defines functions discrete_by_quantile

Documented in discrete_by_quantile

#' Discretize a Vector by Quantiles
#'
#' Discretizes a non-factor input vector and returns the result as numeric.
#'
#' @param x A vector containing arbitrary data.
#' @param ... Additional arguments passed to \code{\link[gtools]{quantcut}}.
#'
#' @return A numeric vector with the data re-coded to based on the quantiles.
#'
#' @importFrom gtools quantcut
#'
#' @export
#'
#' @examples
#' x <- rnorm(1000)
#' discrete_by_quantile(x)
discrete_by_quantile <- function(x, ...) {
  if (!is.factor(x)) {
    as.numeric(gtools::quantcut(x, ...))
  } else {
    as.numeric(x)
  }
}
nhejazi/nima documentation built on March 10, 2020, 1:10 a.m.