frmt_summary_tbl: Format stock summary table

Description Usage Arguments Value Note Author(s) See Also Examples

View source: R/clean_raw_data.R

Description

frmt_summary_tbl returns the stock summary table plain and formatted with html (e.g., glyphicons and italics)

Usage

1
2
frmt_summary_tbl(active_year = active_year,
  calculate_status = calculate_status, return_clean_sag = FALSE)

Arguments

active_year

numeric of the stock database version. e.g., 2016

calculate_status

logical on whether to use raw SAG output to calculate stock status or to use the hard-coded values from stock summary table

return_clean_sag

logical to return objects from clean_sag()

Value

data frame

Note

Periodically, ICES adds or removes stocks from the advisory process. The function returns the stock summary table for all published (in SAG) and active stocks for a given year. calculate_status = TRUE calculates stock status relative to published reference points. This will represent PA and SBL for ecoregions with proxy reference points. calculate_status = TRUE takes the raw icons from published advice. Note, before 2017 not all stocks status tables have been added to the SAG database and only few stocks had MSY proxy reference points.

Author(s)

Scott Large

See Also

Used in stockSummaryTable_fun to create the "Status of stock summary relative to reference points" table for all stocks for an ecoregion. Input data: SAG summary table and reference points come from clean_sag.

Examples

1
head(frmt_summary_tbl(active_year = 2016)$summary_table)

ices-tools-prod/fisheryO documentation built on Feb. 14, 2018, 1:21 p.m.