getPrs: Get a TCSAM02 prs object by reading initial and final...

Description Usage Arguments Details Value

View source: R/getPrs.R

Description

Function to get a TCSAM02 prs object by reading initial and final parameters csv file.

Usage

1
getPrs(type = "all", inp.dir = ".", verbose = FALSE)

Arguments

type

- 'all' or 'active'

inp.dir

- folder for files

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 Nov. 10, 2018, 7:42 p.m.