R/sing_day.R

In PaolaRendon/twelvedays: Sing the 12 Days of Christmas

#' Takes a noun and makes it plural
#'
#' @param dataset A data frame containing information about gifts
#' @param line The number of the line for the day you want to sing about
#' @param phrase_col The variable name for the column in the dataset that
#' contains the gift phrases
#'
#' @return A string singing the line of the song with all gifts for the given day.
#'
#' @import stringr
#' @import dplyr
#' @import glue
#' @import purrr
#' @import english
#'
#' @export

sing_day <- function(dataset, line, phrase_col){

  phrases <- dataset %>% pull({{phrase_col}})

  phrases <- head(phrases, line)
  
  phrases <- str_trim(phrases)

  day_phrases <- map(phrases, invisible)

  line <- ordinal(line)
  
  day_phrases <- rev(day_phrases)
  
  day_phrases <- glue_collapse(day_phrases, sep = ",\n")

  day_phrases <- str_replace_all(day_phrases, " ,", ",")

  glue("On the {line} day of Christmas, my true love sent to me,
  {day_phrases}.")

}