plot_summary {gen3sis}

Plot simulation default summary object

Description

Plot simulation default summary object

Usage

plot_summary(output, summary_title = NULL, summary_legend = NULL)

Arguments

output

a sgen3sis output object resulting from a gen3sis simulation (i.e. run_simulation)

summary_title

summary plot title as character. If NULL, title is computed from input name.

summary_legend

either a string using \n for new lines or NULL. If NULL, provides default summary and simulation information.

Value

no return value, called for plot

See Also

run_simulation

Examples

# load existing summary example
datapath <- system.file(file.path("extdata", "WorldCenter"), package = "gen3sis")
output <- readRDS(file.path(datapath, "output/config_worldcenter/sgen3sis.rds"))
# plot output summary
plot_summary(output)

plot_summary(output, summary_title="Example")


## run simulation and plot summary
# get path or correct input objects
datapath <- system.file(file.path("extdata", "CaseStudy1"), package="gen3sis")
# run simulation and store summary object to output
output <- run_simulation(config = file.path(datapath,"config/config_fast.R"), 
                      landscape = file.path(datapath,"landscape"),
                      output_directory = tempdir())
# plot output summary
plot_summary(output)