R/outcome_table.R

In ericmkeen/shipstrike: Utilities for spatially- and temporally-explicit predictions of whale-ship collisions

#' Tabular summary of ship strike outcomes
#'
#' This function summarizes the predictions for each stage
#' of whale-vessel interaction, from cooccurrence to mortality.
#'
#' @param outcomes A `data.frame` of results from the `shipstrike::gather_outcomes()` function.
#'
#' @return A `data.frame`. See the output of `outcome_predict()`.
#' @export
#'
outcome_table <- function(outcomes){
  mr <- outcomes

  melted <- outcome_melt(mr)
  head(melted)

  grand_table <-
    melted %>%
    group_by(event, iteration) %>%
    summarize(outcome = sum(outcome)) %>%
    group_by(event) %>%
    summarize(mean = round(mean(outcome),2),
              median = median(outcome),
              q5 = quantile(outcome, .05),
              q95 = quantile(outcome,.95),
              q20 = quantile(outcome,.2))

  grand_table
  return(grand_table)
}