R/capital_quiz.R

In jhollist/maxmaps: What the Package Does

#' Capital quiz
#'
#' This function gives a quiz for each of the capitals based on region or regions
#' @param ... a list of brms regions to use for quiz.  Included in
#'                `states_caps`` data frame.
#' @param type Which type of test to take, can be "mc" of "fill".  Only "fill"
#'             is currently implemented.
#' @import dplyr USAboundaries ggplot2
#' @export
capital_quiz <- function(..., type = c("fill", "mc")){
  data("states_caps", package = "maxmaps")
  regions <- unlist(list(...))
  if(any(!regions %in% c("northeast", "southeast", "midwest",
                        "southwest", "west"))){
    stop('The list of regions must be one of: "northeast", "southeast",
         "midwest","southwest", or "west"')
  }
  type <- match.arg(type)
  #browser()
  quiz_data <- states_caps %>%
    filter(brms_regions %in% regions) %>%
    arrange(sample(1:nrow(.)))
  score <- vector("numeric", nrow(quiz_data))
  spell_corr <- vector("numeric", nrow(quiz_data))
  user_answers <- vector("character", nrow(quiz_data))

  for(i in seq_along(quiz_data[,1])){
    region_states <- quiz_data %>%
      filter(brms_regions == quiz_data[i,4]) %>%
      pull(state)
    current_region <- quiz_data %>%
      filter(brms_regions == quiz_data[i,4]) %>%
      pull(brms_regions) %>%
      unique()
    region <- us_boundaries(resolution = "high") %>%
      filter(name %in% region_states)
    state <- us_boundaries(resolution = "high") %>%
      filter(name %in% quiz_data[i,1])
    map <- ggplot(region) +
      geom_sf() +
      geom_sf(data = state, fill = "black")
    if(current_region == "southwest"){
      map <- map +
        scale_x_continuous(limits = c(-180, -90))
    }

    if(type == "fill"){
      print(map)
      user_answer <- readline("What is the state capital of the state shown in black? ")
      user_answers[i] <- user_answer
      if(user_answer == quiz_data[i,3]){

        score[i] <- 1
        spell_corr[i] <- 1
        if(i%%2 == 0){
          message(praise::praise(template = "Correct!, you are ${adjective}"))
        } else {
          dadjoke::groan()
        }
        } else if(stringdist::stringsim(quiz_data[i,3], user_answer) >= 0.5){
          score[i] <- 1
          spell_corr[i] <- 0
          message("That looks close, so you get a point")
          message(paste0("You typed ", user_answer, ' and the correct answer is ',
                         quiz_data[i,3], '.'))
          message("Can you see the difference?")
        }
        else {
        score[i] <- 0
        spell_corr[i] <- 0
        message("Sorry, not quite right")
        message(paste0("You typed ", user_answer, ' and the correct answer is ',
                      quiz_data[i,3], '.'))
        message("Can you see the difference?")
      }
    } else if(type == "mc"){}
    #continue <- ""
    #while(continue == ""){
    #  continue <- tolower(readline('Type "y" to continue: '))
    #y  if(continue != "y"){return()}
    #}
  }
  message("You are done!")
  message(paste("You got", sum(score), "out of", length(score), "correct."))
  message(paste("You spelled", sum(spell_corr), "out of", length(score), "correct. And get extra credit for those."))
  message(paste0("That's ", round(100*((sum(score)+sum(spell_corr))/length(score)), 1), "%."))
  message("Here are the ones you didn't get perfect this time.")
  wrong <- data.frame(your_answers = user_answers[!spell_corr],
             correct_answers = quiz_data[!spell_corr,3])
  wrong
}