write_fpa: Write FPA text file

Description Usage Arguments Value Examples

Description

Write FPA text file

Usage

1
write_fpa(fpdat, spfi, stocks, comment = NA, filename = NA)

Arguments

fpdat

A data frame, equivalent structure to the first element of the list that is produced by calc_fp

spfi

A data frame. Annual estimates of the SPFI. Must include columns named 'return.year' and 'S.y' (the SPFI).

stocks

A data frame with the first column identifying the three letter stock name and the second column being the stock number. Column names are not necessary.

comment

A character vector of length one. The comment to be included in line 1 of the FPA file.

filename

A character vector of length one. Required filename for the output FPA file.

Value

This function only writes the FPA text file. Nothing is returned.

Examples

1
2
3
4
5
## Not run: 
dat.fp <- calc_fp(...)
write_fpa(dat.fp[[1]], spfi, stocks, comment="wcvi", "fpa_results.fpa", )

## End(Not run)

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