LandisScenario class

Keeps track of a scenario's files and all its extensions' input files.

Public fields

path

character specifying the (directory) path to the scenario file

files

character specifying the filenames of the scenario files (relative to path)

extensions

list of LandisExtension objects

Active bindings

reps

integer number of replicates created for this scenario

output_files

Character vector of output files always produced by LANDIS-II in the scenario directory, regardless of which extensions are active. Collected by scenario() when writing output_manifest.txt.

Methods

Public methods

• LandisScenario$new()

• LandisScenario$add_file()

• LandisScenario$list_extensions()

• LandisScenario$list_files()

• LandisScenario$replicate()

• LandisScenario$clone()

---

LandisScenario$new()

Usage

LandisScenario$new(path = NA_character_, extensions = list())

Arguments

path

character specifying the (directory) path to the scenario file

extensions

list of LandisExtension objects

file

character specifying the filename of the scenario file (relative to path)

---

LandisScenario$add_file()

Usage

LandisScenario$add_file(value)

Arguments

value

if specified, the new value to append to files

---

LandisScenario$list_extensions()

Usage

LandisScenario$list_extensions(type)

Arguments

type

character specifying the extension type (must be one of: succession, disturbance, other)

---

LandisScenario$list_files()

Usage

LandisScenario$list_files(full.names = TRUE)

Arguments

full.names

logical indicating whether full absolute file paths should be returned

---

LandisScenario$replicate()

Usage

LandisScenario$replicate(n)

Arguments

n

integer specifying the number of replicates to generate

---

LandisScenario$clone()

The objects of this class are cloneable with this method.

Usage

LandisScenario$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.