R/get_ord_numbers.R

Defines functions get_ord_numbers

Documented in get_ord_numbers

#' Get Ordinal Numbers
#'
#' Function that accepts a column of R Integer values (typically from a Rank column or when using row_number) and returns Ordinal Numbers
#' (1st, 2nd, 3rd etc).
#'
#' @param df numeric
#'
#' @return
#' @importFrom dplyr case_when
#' @export
#'
#' @examples
#'
#' df2 <- df %>%
#' arrange(sales) %>%
#' mutate(Rank = row_number(),
#'        Rank_ord = get_ord_numbers(Rank))
#'
#'
get_ord_numbers <- function(df){
  new_df <- case_when(df %in% c(11, 12, 13) ~ "th",
                      df %% 10 == 1 ~ 'st',
                      df %% 10 == 2 ~ 'nd',
                      df %% 10 == 3 ~ 'rd',
                      TRUE ~ 'th')
  new_df2 <- paste0(df, new_df)
  return(new_df2)

}
jyablonski/practice_package documentation built on Dec. 21, 2021, 5:14 a.m.