getPrs: Get a TCSAM02 prs object by reading initial and final...
In wStockhausen/rTCSAM02: A set of tools to set up input for, and interact with output from, TCSAM02 model runs
getPrs R Documentation
Get a TCSAM02 prs object by reading initial and final parameters csv files
Description
Function to get a TCSAM02 prs object by reading initial and final parameters csv file.
Usage
getPrs(type = "all", inp.dir = ".", verbose = FALSE)
Arguments
type
'all' or 'active'
inp.dir
folder for files
verbose
flag to print information
Details
To create the prs object, this function reads 2 csv-type parameter value files,
one associated with the initial parameter values and one associated with the final values
(tcsam02...init.csv and tcsam02...final.csv, respectively).
The user can select to return either "all" the parameters, or only the "active" parameters (ones
with phase > 0). The returned object will be a dataframe of class 'tcsam02.prs'.
Value
A prs model object (a dataframe). The returned object will be a list of class 'tcsam02.prs'.
wStockhausen/rTCSAM02 documentation built on April 16, 2024, 6:25 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| getPrs | R Documentation |
Get a TCSAM02 prs object by reading initial and final parameters csv files
Description
Function to get a TCSAM02 prs object by reading initial and final parameters csv file.
Usage
getPrs(type = "all", inp.dir = ".", verbose = FALSE)
Arguments
type |
|
inp.dir |
|
verbose |
|
Details
To create the prs object, this function reads 2 csv-type parameter value files, one associated with the initial parameter values and one associated with the final values (tcsam02...init.csv and tcsam02...final.csv, respectively). The user can select to return either "all" the parameters, or only the "active" parameters (ones with phase > 0). The returned object will be a dataframe of class 'tcsam02.prs'.
Value
A prs model object (a dataframe). The returned object will be a list of class 'tcsam02.prs'.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.