osmose_demo: Generates required OSMOSE configuration files to run a demo.

Description Usage Arguments Value Note Examples

View source: R/osmose-main.R

Description

Thins function

Usage

1
osmose_demo(path = NULL, config = "gog")

Arguments

path

Path where to put the Osmose configuration file.

config

Reference configuration to run ("gog").

Value

A list containing the configuration file to use (config_file) for running the code and the output directory to use when reading data.

Note

So far, only one configuration is propose ("gog")

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
## Not run: 
rm(list=ls())

library("osmose")

# Copy configuration files into the proper directory
demo = osmose_demo(path="../", config="gog")

# run the osmose model
run_osmose(demo$config_file, parameters=NULL, output=NULL, version="3.3.3", 
          options=NULL, verbose=TRUE, clean=TRUE)

# reads output data
data = read_osmose(demo$output_dir)

# summarize output data
summary(data)

# plot output data
plot(data)

## End(Not run)

osmose documentation built on April 28, 2020, 5:06 p.m.