Skip to contents

Original Wind Extension

OriginalWind.Rd

Original Wind Extension

References

LANDIS-II Original Wind v4.1 Extension User Guide https://github.com/LANDIS-II-Foundation/Extension-Base-Wind/blob/master/docs/LANDIS-II%20Original%20Wind%20v4%20User%20Guide.pdf

See also

Helpers that prepare inputs for this extension: prepWindEventParametersTable().

Other Original Wind helpers: defaultWindSeverities(), insertWindEventParametersTable(), insertWindSeverities(), prepWindEventParametersTable()

Super class

LandisExtension -> OriginalWind

Active bindings

WindEventParametersTable

data.frame with columns Ecoregion, MaxSize, MeanSize, MinSize, WindRotationPeriod.

WindSeverities

data.frame with columns Severity, LowerAge, UpperAge, MortalityProbability.

MapNames

Character. File pattern for writing outputs to disk; must contain {timestep}.

SummaryLogFile

Character. Relative file path.

EventLogFile

Character. Relative file path.

output_files

Character vector of output files (relative paths from the scenario directory) that this extension is expected to produce at run time. Subclasses override this to return their extension-specific log files, event CSVs, etc. These paths are collected by scenario() and written to output_manifest.txt so tar_landis() can track them explicitly without relying on list.files() discovery.

Map files whose names depend on the timestep (e.g. BiomassC-10.tif) are NOT included here; they are discovered by tar_landis()'s output_dir scan instead.

Methods

Public methods

Inherited methods

OriginalWind$new()

Usage

OriginalWind$new(
  path,
  Timestep = NULL,
  WindEventParametersTable = NULL,
  WindSeverities = NULL,
  MapNames = NULL,
  SummaryLogFile = "wind/summary-log.csv",
  EventLogFile = "wind/event-log.csv"
)

Arguments

path

Character. Directory path.

Timestep

Integer.

WindEventParametersTable

data.frame with columns Ecoregion, MaxSize, MeanSize, MinSize, WindRotationPeriod (see prepWindEventParametersTable()).

WindSeverities

data.frame with columns Severity, LowerAge, UpperAge, MortalityProbability; rows must be ordered by decreasing Severity. Defaults to defaultWindSeverities().

MapNames

Character. File pattern for writing outputs to disk; must contain {timestep}.

SummaryLogFile

Character. Relative file path.

EventLogFile

Character. Relative file path.

OriginalWind$write()

Write extension inputs to disk

Usage

OriginalWind$write()

OriginalWind$clone()

The objects of this class are cloneable with this method.

Usage

OriginalWind$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.