R/ftc_factor_exp_anual.R

In endomer/encftr: Funciones para trabajar con la ENCFT

#' Factor de expansión anual
#'
#'   `r lifecycle::badge("stable")`
#'
#' @param tbl [data.frame]: Conexión a base de datos o dataframe con los datos.
#'
#' @return Conexión a base de datos o dataframe según input con la variable
#'   \code{factor_exp_anual} agregada.
#'
#' @export
#'
#' @examples
#'   encft <- data.frame(FACTOR_EXPANSION = c(1028, 848, 400))
#'   ftc_factor_exp_anual(encft)
ftc_factor_exp_anual <- function(tbl){
  FACTOR_EXPANSION <- NULL
  tbl %>%
    dplyr::mutate(
      factor_exp_anual = FACTOR_EXPANSION/4
    )
}

#' @rdname ftc_factor_exp_anual
#' @export
ftc_compute_factor_exp_anual <- function(tbl) {
  deprecate_warn("0.5.0", "ftc_compute_factor_exp_anual()", "ftc_factor_exp_anual()")
  ftc_factor_exp_anual(tbl)
}