plot_single_run: plot sim.single_run outputs

View source: R/plot_single_run.R

plot_single_runR Documentation

plot sim.single_run outputs

Description

A function to plot delta and size vs time from the sim.single_run outputs

Usage

plot_single_run(
  workdir,
  RUN_ID,
  time_as_log10 = TRUE,
  time_unit = NULL,
  hidden_boxes = NULL,
  return_as_print = TRUE
)

Arguments

workdir

Working directory of isobxr excel master file and where output files will be stored if exported by user. (character string)

RUN_ID

ID of the run (formerly SERIES_RUN_ID). Corresponds to the name of the .rds file storing the results of the run.

time_as_log10

If TRUE, uses logarithmic time scale in plot.
Default is TRUE.

time_unit

Time unit to use on plot if different from native time unit.
Character string, to be selected among the following:
micros, ms, s, min, h, d, wk, mo, yr, kyr, Myr, Gyr
Default is NULL.

hidden_boxes

List of boxes to hide from plots, as a vector of character strings.
For instance c("SOURCE", "SINK").

return_as_print

If TRUE, prints delta and size vs. time plots in a single page figure on R.
If FALSE, returns separately delta and size vs. time plots as list of editable R objects.
Default is TRUE.

Value

A set of plots showing the evolution of delta and sizes with time.


isobxr documentation built on Aug. 23, 2023, 5:06 p.m.