R/woRdleGuess.R

In iain-t-bennett/woRdleSolveR: What the Package Does (One Line, Title Case)

#' woRdleGuess
#'
#' Response defines how good the guess was
#' G is green, Y is yellow, 0 is grey
#' e.g. G0000 means Green for postion 1, grey for the rest
#'
#' @param word 5 letter word
#' @param response is the colour update (5 char string with each char G,Y,0)
#
#' @return
#' @export
#'
#' @examples
#' x <- woRdleGuess("APPLE", "YGG00")
#' print(x)
woRdleGuess <- function(word, response){
  # check form
  assertthat::assert_that(
    nchar(word)==5,
    msg = "word must be 5 letters"
    )

  assertthat::assert_that(
    nchar(response)==5,
    msg = "response must be 5 letters"
  )

  word <- toupper(word)
  response <- toupper(response)

 rc <- new_woRdleGuess(word, response)
 return(rc)
}

# woRdleGuess

new_woRdleGuess <- function(word, response){

  wordarray <- array(data = "1", dim = 5)
  resparray <- array(data = "1", dim = 5)

  for( i in 1:5){
    wordarray[i] <- substr(word,i,i)
    resparray[i] <- substr(response,i,i)
  }

  rc <- list(word = wordarray, response = resparray)

  class(rc) <- "woRdleGuess"

  return(rc)
}

#' print a guess
#'
#' @param x a guess object
#' @param ... unused
#'
#' @return
#' @export
#'
print.woRdleGuess <- function(x,...){

  rg <- which(x$response == "G")
  ry <- which(x$response == "Y")
  r0 <- which(x$response == "0")

  rc <- paste0("Word guessed was ", paste0(x$word, collapse = ""))

  if (length(r0) == 5){
    rc <- paste(rc, "No letters correct", collapse = "\n")
  } else{
    if (length(rg)>0){
      txtg <- paste0("Correct letters are ",paste0(x$word[rg], collapse = ","),
                     " in correct positions ", paste0(rg, collapse = ","))
      rc <- paste(rc, txtg, collapse = "\n")
    }
    if (length(ry)>0){
      txty <- paste0("Correct letters are ",paste0(x$word[ry], collapse = ","),
                     " in wrong positions ", paste0(ry, collapse = ","))
      rc <- paste(rc, txty, collapse = "\n")
    }
  }

  cat(rc)

}


#' plot a guess
#'
#' @param x a guess object
#' @param ... unused
#'
#' @return
#' @export
#'
plot.woRdleGuess <- function(x,...){

  df <- dplyr::tibble(
    i = 1:5) %>%
    mutate(
      letter = x$word[i],
      status = x$response[i],
      color = ifelse(status == "G", "Green", ifelse(status == "Y", "Yellow", "Grey")),
      xpos = i,
      ypos = 1 )

    df$color <- factor(df$color,
                       ordered = TRUE,
                       levels =  c("Green", "Grey", "Yellow"))

  rc <- ggplot2::ggplot(data = df, aes(x= xpos, y = ypos, fill = color)) +
    ggplot2::geom_tile(linetype = 1, size = 1, color = "black") +
    ggplot2::geom_text(aes(label = letter)) +
    ggplot2::theme_void() +
    ggplot2::scale_fill_manual(values = c("Green", "Grey", "Yellow"),
                               drop = FALSE) +
    ggplot2::theme(legend.position = "none")

  return(rc)
}

woRdleGuessNull <- function(){
  rc <- woRdleGuess(word = "     ", response = "00000")
  return(rc)
}