R/show.R

Defines functions show_exposure show_scenario

show_scenario <- function(object, inline=FALSE, ...) {
  if(!inline)
    cli::cli_text("'{object@name}' scenario")

  if(object@tag != "" & !is.na(object@tag))
    cli::cli_text("tag: {object@tag}")

  if(length(object@param) > 0)
    cli::cli_text(cli::col_blue(paste("param:", paste(names(object@param), unlist(object@param), sep="=", collapse=", "))))
  else
    cli::cli_text(cli::col_blue("param: none"))

  if(length(object@init) > 0)
    cli::cli_text(cli::col_blue(paste("init:", paste(names(object@init), unlist(object@init), sep="=", collapse=", "))))
  else
    cli::cli_text(cli::col_blue("init: none"))

  if(length(object@endpoints) > 0)
    cli::cli_text(cli::col_blue(paste("endpt:", paste(object@endpoints, sep=",", collapse=", "))))
  else
    cli::cli_text(cli::col_blue("endpt: none"))

  if(length(object@times) > 0)
    cli::cli_text(cli::col_blue(paste0("times: [", min(object@times), ",", max(object@times), "] n=",
                         length(object@times), ", ", ifelse(is_regular_series(object@times), "regular", "irregular"))))
  else
    cli::cli_text(cli::col_blue("times: none"))

  # biomass transfers
  if(has_transfer(object)) {
    # regular transfers
    if(has_regular_transfer(object)) {
      desc <- paste0("regular, interval=", object@transfer.interval )
    } else {
      tps <- paste(sprintf("%g", head(object@transfer.times, n=6)), collapse=",")
      desc <- paste0("custom, times=c(", tps, ifelse(length(object@transfer.times) > 6, ",...", ""), ")")
    }
    cli::cli_text(cli::col_br_magenta("transf: ", desc, ", ", object@transfer.comp.biomass, "=", sprintf("%g", object@transfer.biomass)))
  }

  # moving windows
  if(has_windows(object)) {
    cli::cli_text(cli::col_br_magenta("windws: length=", sprintf("%g", object@window.length), ", interval=", sprintf("%g", object@window.interval)))
  }

  cli::cli_text(cli::col_green(paste("forcs: ",ifelse(length(object@forcings) == 0, "none", paste0(names(object@forcings), collapse=", ")))))
  show_exposure(object@exposure, inline=TRUE, ...)
}

show_exposure <- function(x, inline=FALSE, show_exposure_series=TRUE) {
  color <- "green"
  nofile <- identical(x@file, character(0))
  if(!nofile) # the expression yields logical(0) for @file=character(0)
    nofile <- x@file %in% c("unknown","")

  if(!inline) {
    cli::cli_text("ExposureSeries object")
    cli::cli_text(cli::col_green("file: {ifelse(nofile, 'none', x@file)}"))
  } else {
    cli::cli_text(cli::col_green("expsr: {ifelse(nofile, '', x@file)}"))
  }

  if(nrow(x@series) > 0) {
    if(show_exposure_series) {
      print(x@series, max=20)
    }
  } else {
    cli::cli_text(cli::col_green(">> exposure series is empty"))
  }
}

#' @importFrom methods show
setMethod("show", "EffectScenario", function(object) show_scenario(object))
setMethod("show", "ExposureSeries", function(object) show_exposure(object))

Try the cvasi package in your browser

Any scripts or data that you put into this service are public.

cvasi documentation built on Sept. 11, 2025, 5:11 p.m.