rmacroliteSimType-methods: Fetch or set the type of simulation in an imported MACRO...

In julienmoeys/rmacrolite: R interface for the pesticide fate models MACRO In FOCUS and MACRO

Description

Fetch or set the type of simulation in an imported MACRO par-file (parent or metabolite; intermediate or not). See the description of the argument value and return below for a description of the different simulation types. Here, the term the "parent" should be understood as a substance directly applied on the field, not a primary or secondary (etc) metabolite. An intermediate simulation is a simulation that outputs only information on the mass of substance is degraded at each time step and in each numerical layer. Such intermediate simulation is then used as input for simulating the fate of the degradation product(s) of this substance.

Usage

rmacroliteSimType(x, ...)

## S3 method for class 'macroParFile'
rmacroliteSimType(x, ...)

rmacroliteSimType( x, warn = TRUE, ... ) <- value

## S3 replacement method for class 'macroParFile'
rmacroliteSimType(x, warn = TRUE, ...) <- value

Arguments

x	A macroParFile, as imported with rmacroliteImportParFile-methods. This file MUST be from a parent substance, and not an intermediate simulation output.
...	Additional parameters passed to specific methods. Currently not used.
warn	Argument passed to rmacroliteInfo. See rmacroliteInfo for details.
value	A list with two items. The items can be named "type" and "drivingfile". The first item ("type") should be a single integer-value indicating the type of simulation and the second item ("drivingfile") should be a single character-string indicating the name of the bin-file to be read-in when simulating a metabolite. This file should therefore be an intemediate simulation output. When "type" is set to 1 or 2 (ie a parent substance), the second item can be skipped entirely. The first item ("type") indicates the type of simulation x should be changed to: 1 is for setting the simulation to a parent substance, not intermediate simulation output, 2 is for changing to a parent substance, intermediate simulation output, 3 is for changing to a metabolite, not intermediate simulation output and 4 is for changing to a metabolite, intermediate simulation output. In practice, as x must be a type 1 (parent, not intermediate simulation output), setting value to 1 is pointless.

Value

A list with two named items. The first item ("type") is a single integer-value indicating the type of simulation and the second item ("drivingfile") is a single character-string indicating the name of the bin-file to be read-in when simulating a metabolite. This file is therefore be an intemediate simulation output. The first item ("type") indicates the type of simulation x presumably contains: 1 is for a parent substance, not intermediate simulation output, 2 is a parent substance, intermediate simulation output, 3 is a metabolite, not intermediate simulation output and 4 is a metabolite, intermediate simulation output.

julienmoeys/rmacrolite documentation built on May 22, 2019, 6:31 p.m.