R/utility_functions.R

In amfz/dlarxiv: Download ArXiv Papers Responsibly

#' Clean Title Names
#'
#' Clean up text for use as file names. Converts all characters to lowercase, removes  punctuation and extra whitespace, replaces spaces between words with underscores, and adds ".pdf" to the end of the title.
#'
#' @param data data frame
#' @param col text column in the data frame to clean up. "title" by default.
#'
#' @return Character vector of cleaned text.
#'
#' @examples
#' df <- data.frame(title = c("Paper Title: Subtitle", "O Rly? A Study"), pages = c(20, 40))
#' df$cleaned <- clean_titles(df)
#'
#'
#' @export
clean_titles <- function(data, col = "title") {
  # make the titles all lowercase
  cleaned <- tolower(data[, col])
  # replace punctuation with spaces
  cleaned <- gsub("[[:punct:]]", " ", cleaned)
  # reduce multiple whitespace chars to one
  cleaned <- gsub("[[:space:]]{2,}", " ", cleaned)
  # trim whitespace
  cleaned <- trimws(cleaned)
  # replace spaces with underscores
  cleaned <- gsub("[[:space:]]", "_", cleaned)
  cleaned <- paste0(cleaned, ".pdf")
  cleaned
}