R/ftc_grupos_edad.R

In endomer/encftr: Funciones para trabajar con la ENCFT

#' Grupos de edad
#'
#'   `r lifecycle::badge("experimental")`
#'
#'   Divide la variable \code{EDAD} en el número o los grupos especificados.
#'
#' @param tbl [data.frame]: Conexión a base de datos o data.frame con los datos
#' @param breaks Puntos de corte para la variable. Vea \code{See also} para más detalles.
#' @param labels Nombres para los grupos de la variable.  Vea \code{See also} para más detalles.
#'
#' @return [data.frame]: Los datos suministrados en el argumento \code{tbl} con
#'   la variable \code{grupos_edad} adicionada.
#'
#' @seealso
#'    Vea \code{Dmisc::\link[Dmisc:cut3]{cut3}}
#'
#' @export
#'
#' @examples
#'   encft <- data.frame(EDAD = c(0:100))
#'   ftc_grupos_edad(encft)
ftc_grupos_edad <- function(tbl, breaks = 10, labels = NULL){
  EDAD <- NULL
  tbl <- dplyr::mutate(tbl, grupos_edad = EDAD)
  Dmisc::cut3(tbl, "grupos_edad", breaks, labels = labels)
}


#' @rdname ftc_grupos_edad
#' @export
ftc_compute_grupos_edad <- function(tbl, breaks = 10, labels = NULL){
  deprecate_warn("0.5.0", "ftc_compute_grupos_edad()", "ftc_grupos_edad()")
  ftc_grupos_edad(tbl, breaks, labels)
}