R/fish_count.R

Defines functions fish_count

# ESM 262 Assignment 4
# Gabriel De La Rosa, Quin Smith, Ruoyu Wang
# function to count fish

# Variable inputs
# fish, a vector of different fish
# hist.plot, whether to include a histogram as part of the output

fish_count <- function(fish, hist.plot = FALSE){
  # Add error if input is not a character/factor:
  if((class(fish) == "character") == FALSE){
    return("fish is not a character vector!")
  }
  fish = as.factor(fish)
  # Prepare outputs
  most_fish = names(which.max(summary(fish)))
  rarest_fish = names(which.min(summary(fish)))
  total_fish = sum(summary(fish))
  
  # Conditional histogram:
  if(hist.plot) {
    return(list(most = most_fish, rarest = rarest_fish, total = total_fish, fish_plot = plot(fish,
                                                                                           main = sprintf("%i Total Fish Caught", total_fish))))
  } else {
    return(list(most = most_fish, rarest = rarest_fish, total = total_fish))
    }
  
}
Ruoyu-Wang108/test documentation built on March 4, 2021, 12:48 a.m.