read_osmose: Read OSMOSE outputs into an R object

In osmose-model/osmose: Object Oriented Simulator of Marine Ecosystems

Read OSMOSE outputs into an R object

Description

This function create object of class osmose with the outputs from OSMOSE in the path folder.

Usage

osmose2R(path = NULL, version = "v3r2", species.names = NULL, ...)

read_osmose(
  path = NULL,
  input = NULL,
  version = "4.3.2",
  species.names = NULL,
  absolute = TRUE,
  ...
)

Arguments

path	Path to the directory containing OSMOSE outputs.
version	OSMOSE version used to run the model.
species.names	Display names for species, overwrite the species names provided to the OSMOSE model. Used for plots and summaries.
...	Additional arguments.
input	Path to a main OSMOSE configuration file.
absolute	Whether the path is absolute (TRUE) or relative (FALSE). Only used if input is not NULL.

Details

read_osmose will return a list of fields with the information of whether an OSMOSE running or the configuration that is going to be used in a running. Output class will depend on the read info: If path is specified, output class will be osmose; otherwise, if ONLY input is given, the class will be osmose.config. If both are specified, the osmose class output will content inside a field (config) of class osmose.config.

Individual elements can be extracted using the get_var function.

Author(s)

Ricardo Oliveros-Ramos, Laure Velez

Examples

# Read outputs generated by demo (check osmose_demo function)
outdir = cacheManager("outputs")
read_osmose(path = outdir)
  

osmose-model/osmose documentation built on Feb. 16, 2023, 5 a.m.