R/print.mdl_rn.R

In Allgeier-Lab/arrR: Individual-Based Simulation Model of Artifical Reefs in R

#' print.mdl_rn
#'
#' @description
#' Printing method.
#'
#' @param x mdl_rn object.
#' @param digits Numeric of decimal places (round).
#' @param ... Arguments passed to cat.
#'
#' @details
#' Printing method for \code{mdl_rn} object simulated with \code{\link{run_simulation}}.
#' Includes information about the model run and resulting seafloor and fishpop values.
#'
#' @examples
#' \dontrun{
#' print(result_rand)
#' }
#'
#'
#' @aliases print.mdl_rn
#' @rdname print.mdl_rn
#'
#' @export
print.mdl_rn <- function(x, digits = 3, ...) {

  # get seafloor values of selected time step
  seafloor_values <- x$seafloor[x$seafloor$timestep == max(x$seafloor$timestep),
                                c("ag_biomass", "bg_biomass",
                                  "nutrients_pool", "detritus_pool")]

  min_seafloor <- round(apply(X = seafloor_values, MARGIN = 2,
                              FUN = min, na.rm = TRUE),
                        digits = digits)

  mean_seafloor <- round(apply(X = seafloor_values, MARGIN = 2,
                               FUN = mean, na.rm = TRUE),
                         digits = digits)

  max_seafloor <- round(apply(X = seafloor_values, MARGIN = 2,
                              FUN = max, na.rm = TRUE),
                        digits = digits)

  #  fish population present
  if (nrow(x$fishpop > 0)) {

    # get fish population values of selected time step
    fishpop_values <- x$fishpop[x$fishpop$timestep == max(x$fishpop$timestep),
                                c("length", "weight", "died_consumption", "died_background")]

    # calculate min, median, max values
    min_fishpop <- round(apply(X = fishpop_values, MARGIN = 2, FUN = min, na.rm = TRUE),
                         digits = digits)

    mean_fishpop <- round(apply(X = fishpop_values, MARGIN = 2, FUN = mean, na.rm = TRUE),
                          digits = digits)

    max_fishpop <- round(apply(X = fishpop_values, MARGIN = 2, FUN = max, na.rm = TRUE),
                         digits = digits)

  # no fish population present
  } else {

    min_fishpop <- NA

    mean_fishpop <- NA

    max_fishpop <- NA

  }

  # count reef cells
  reef_cells <- sum(x$seafloor[x$seafloor$timestep == 0, "reef"])

  # get minimum time step
  min_time <- unique(min(x$seafloor$timestep))

  # calculate total time in days rounded
  total_time <- round((x$max_i - min_time) * x$min_per_i / 60 / 24, digits = 2)

  save_time <- round(x$save_each * x$min_per_i / 60 / 24, digits = 2)

  # print result
  cat(paste0("Total time : ", paste0(c(min_time, x$max_i), collapse = "-"), " iterations (", total_time, " days) [Burn-in: ", x$burn_in, " iter.]\n",
             "Saved each : ", x$save_each, " iterations (", save_time, " days)\n",
             "Seafloor   : ", x$dimensions[1], " rows x " , x$dimensions[2],  " cols; ", reef_cells, " reef cell(s)\n",
             "Fishpop    : ", x$starting_values$pop_n, " indiv (movement: '", x$movement,"')\n",
             "\n",
             "Seafloor : (ag_biomass, bg_biomass, nutrients_pool, detritus_pool)\n",
             "Minimum  : ", paste0(min_seafloor, collapse = ", "), "\n",
             "Mean     : ", paste0(mean_seafloor, collapse = ", "), "\n",
             "Maximum  : ", paste0(max_seafloor, collapse = ", "), "\n",
             "\n",
             "Fishpop  : (length, weight, died_consumption, died_background)\n",
             "Minimum  : ", paste0(min_fishpop, collapse = ", "), "\n",
             "Mean     : ", paste0(mean_fishpop, collapse = ", "), "\n",
             "Maximum  : ", paste0(max_fishpop, collapse = ", "), "\n"))

}