import_toxswa {cvasi} | R Documentation |
Import TOXSWA exposure series
Description
Read one or more TOXSWA exposure series from TOXSWA's .out
files. By default, the
concentration dissolved in water (ConLiqWatLay) at the end of the simulated waterbody
(i.e. at the maximum of the x dimension) is returned. The unit of the time
scale as well as of the imported model output variable can be scaled as needed.
Usage
import_toxswa(
files,
alias = NA,
output_var = "ConLiqWatLay",
output_unit = "ug/L",
time_unit = "days",
substance = NULL,
split = TRUE
)
Arguments
files |
vector of strings with absolute or relative paths to files |
alias |
optional vector with strings, will be used as an alias to identify a TOXSWA series instead of its filename |
output_var |
character, single output variable from TOXSWA that is imported, defaults to ConLiqWatLay |
output_unit |
character, target unit of the imported output variable,
defaults to ug/L, syntax must be compatible with |
time_unit |
character, target unit of the imported time scale,
defaults to days, syntax must be compatible with |
substance |
optional vector of characters, if set, only the substance codes defined in this vector are imported |
split |
logical, if |
Details
The numerical time scale is shifted to always start at time zero (0.0).
Numerical columns of the returned data.frame objects will be of type
units::units. Please be aware that the use of units
objects may not be
supported by all functions in this package. However, set_times()
and
set_exposure()
can handle units
objects safely.
Incomplete list of alternative TOXSWA v5.5.3 output variables:
-
ConLiqWatLay: Concentration dissolved in water (g/m3)
-
ConLiqSed: Concentration in pore water sediment (g/m3)
-
ConSysWatLay: Total concentration in water (g/m3)
-
CntSorSusSol: Content sorbed to suspended solids (g/kg)
-
CntSorSed: Content sorbed to sediment (g/kg)
Value
list of data.frame objects with exposure series. Each data.frame has at least three columns:
-
time
: numerical time scale, always starts at zero -
timestamp
: time as datetime objects such asPOSIXct
one or more additional columns for each imported substance