diff --git a/R/rename.R b/R/rename.R index ea64480..593dc29 100644 --- a/R/rename.R +++ b/R/rename.R @@ -1,17 +1,17 @@ -#' Functions renamed in December 2021 +#' Functions renamed in phsmethods 0.2.1 (Dec 2021) #' #' @description #' `r lifecycle::badge('deprecated')` #' -#' We renamed a number of function to improve code clarity. -#' The old functions are still usable but will produce a warning. -#' After a reasonable amount of time they will be removed completely. +#' phsmethods 0.2.1 renamed a number of functions +#' to improve code clarity. The old functions will still +#' work but will produce a warning. After a reasonable +#' amount of time they will be removed completely. #' #' * `postcode()` -> `format_postcode()` #' * `age_group()` -> `create_age_groups()` #' * `fin_year()` -> `extract_fin_year()` #' -#' #' @keywords internal #' @name rename #' @aliases NULL @@ -35,11 +35,13 @@ age_group <- function(x, as_factor = FALSE) { lifecycle::deprecate_warn("0.2.1", "age_group()", "create_age_groups()") - return(create_age_groups(x = x, - from = from, - to = to, - by = by, - as_factor = as_factor)) + return(create_age_groups( + x = x, + from = from, + to = to, + by = by, + as_factor = as_factor + )) } #' @rdname rename diff --git a/man/rename.Rd b/man/rename.Rd index 16e656f..567b7f1 100644 --- a/man/rename.Rd +++ b/man/rename.Rd @@ -4,7 +4,7 @@ \alias{postcode} \alias{age_group} \alias{fin_year} -\title{Functions renamed in December 2021} +\title{Functions renamed in phsmethods 0.2.1 (Dec 2021)} \usage{ postcode(x, format = c("pc7", "pc8")) @@ -13,14 +13,16 @@ age_group(x, from = 0, to = 90, by = 5, as_factor = FALSE) fin_year(date) } \description{ -`r lifecycle::badge('deprecated')` +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} -We renamed a number of function to improve code clarity. -The old functions are still usable but will produce a warning. -After a reasonable amount of time they will be removed completely. - -* `postcode()` -> `format_postcode()` -* `age_group()` -> `create_age_groups()` -* `fin_year()` -> `extract_fin_year()` +phsmethods 0.2.1 renamed a number of functions +to improve code clarity. The old functions will still +work but will produce a warning. After a reasonable +amount of time they will be removed completely. +\itemize{ +\item \code{postcode()} -> \code{format_postcode()} +\item \code{age_group()} -> \code{create_age_groups()} +\item \code{fin_year()} -> \code{extract_fin_year()} +} } \keyword{internal}