stockSummaryTable_fun: Render html stock summary table

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

View source: R/plot_functions.R

Description

This function returns "Status of stock summary relative to reference points" for all stocks in an ecoregion.

Usage

1
2
3
stockSummaryTable_fun(ecoregion, active_year = 2016,
  table_type = c("static_docx", "dynamic_html")[1], output_path = NULL,
  file_name = NULL, return_data = FALSE)

Arguments

ecoregion

ecoregion name, e.g. Greater North Sea

active_year

numeric of the stock database version (year). e.g., 2016

table_type

type of table, "dynamic_html" (using DT) and "static_docx" (using flextable and officer) .docx tables.

output_path

path for output to live.

file_name

name for the output.

return_data

logical on returning a .csv of plotted data

Value

A html file. When file_name is NULL, the file name is the ecoregion. When output_path is NULL, the file is saved to "~/". When table_type is "static" or "both", it might take a bit of time...

Note

Stocks are linked to ecoregions via the ICES Stock database. Reference points are as published in ICES Stock Assessment Graphs database. In some cases, status relative to reference points may vary from published ICES advice when reported F or SSB are very close to reference points (e.g., F = 0.201 > F<sub>MSY</sub> = 0.20).

Periodically, ICES adds or removes stocks from the advisory process. The function returns the SAG reference points and summary table for all published (in SAG) and active stocks for a given year.

Author(s)

Scott Large

See Also

SAG summary table and reference points come from clean_sag. frmt_summary_table evaluates status relative to reference points and formats the table for .html.

Examples

1
2
3
4
## Not run: 
stockSummaryTable_fun("Greater North Sea Ecoregion")

## End(Not run)

ices-tools-prod/fisheryO documentation built on May 19, 2019, 8:22 a.m.