R/states_random.R

In etc5523-2020/r-package-assessment-AbhishekSinha28: ETC5523 Shiny Package

#' Compare two states
#' 
#' @description This function is used in the shiny application to provide two random state names each time it is loaded for the default values.
#' 
#' @param data The data set to be sampled from.
#'
#' @return A collection of two state names returned from the a data set.
#' 
#' @export
#'
#' @examples
#' states_random(usa_state_map)
#' 
states_random <- function(data){
  states <- unique(data$region)
  sample(states, 2)
}