readStockData: (SPFI) Read CTC stock file (stocfile.stf).

Description Usage Arguments Value Examples

Description

(SPFI) Read CTC stock file (stocfile.stf).

Usage

1
readStockData(filename = "stocfile.stf")

Arguments

filename

A string of length one. The default value is "stocfile.stf".

Value

A list of four elements. The first element, stockmeta, holds the meta data found in the first five lines of the stock file. The second element, SPFIFlag, is a data frame defining what stock-age combinations will be included in the analysis. The third element, SPFIFlag.long, is the same as SPFIFlag, but reshaped to a long format. The fourth element, stocks.df, is the table of stocks (found in the stock file).

Examples

1
2
3
4
## Not run: 
data.stock <- readStockData('STOCFILE.STF')

## End(Not run)

MichaelFolkes/ctctools documentation built on May 7, 2019, 4:56 p.m.