| Title: | What the Package Does (Title Case) |
|---|---|
| Description: | More about what it does (maybe more than one line) Use four spaces when indenting paragraphs within the Description. |
| Authors: | Who wrote it |
| Maintainer: | The package maintainer <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.1.0 |
| Built: | 2024-11-01 17:17:48 UTC |
| Source: | https://github.com/FRAMverse/framrosetta |
This table is based on Chinook stock tables from pre-season 2024. Additional stock may be added in the future (splitting out stock aggregates). The 'bk_lookupfun_chin()' function accommodates this.
bk_lookup_chinbk_lookup_chin
A data frame with 116 rows and 3 columns:
Stock name
Stock ID in the BackwardsFRAM table
Stock ID anywhere else in FRAM and TAMM
At present the FRAM databases use a differents stock_id numbering system in the BackwardsFRAM table than everywhere else. The dataframe 'bk_lookup_chin' provides a lookup table based on the stocks used in Preseason 2024. However, we are working to modify FRAM to support splitting Chinook stock aggregates, which will lead to increased numbers of StockIDs. 'bk_lookupfun_chin' provides an appropruate lookup table based on the 'max_stock' argument, either returning ‘bk_lookup_chin' (if max_stock is not provided or doesn’t exceed the stocks in 'bk_lookup_chin') or extending the dataframe with new stock ids based on the numbering conventions of the bk_stock_id.
bk_lookupfun_chin(max_stock = NA)bk_lookupfun_chin(max_stock = NA)
max_stock |
Positive integer representing the largest *Normal* stock id (stock ids outside of the BackwardsFram table). As of Preseason 2024, there are 78 stocks; splitting stocks might increase this (e.g. 80, 82, 84). Defaults to NA. |
Tibble of lookup table. '$stock_name_bk' gives numan-readable stock names; '$bk_stock_id' gives the "StockID" used in backwards FRAM; '$stock_id' gives the StockID used everywhere else. NAs in '$stock_id' correspond to "totalled" stocks, which are used in backwards FRAM and nowhere else.
temp = bk_lookupfun_chin(80) tail(temp)temp = bk_lookupfun_chin(80) tail(temp)
Mapping of fishery_id to fishery name for Chinook salmon, taken from the 'Fishery' table of the Chinook FRAM database.
fishery_chinook_framfishery_chinook_fram
A data frame with 74 rows and 5 columns:
Species name
Chinook fishery id number in FRAM
Chinook fishery name in FRAM
consistent and more human readable version of 'fishery_name'
2024 Pre-Season Chinook DB.mdb
Mapping of fishery_id to fishery name for Coho salmon, taken from the 'Fishery' table of the Coho FRAM database.
fishery_coho_framfishery_coho_fram
A data frame with 198 rows and 5 columns:
Species name
Coho fishery id number in FRAM
Coho fishery name in FRAM
consistent and more human readable version of 'fishery_name'
2024NOF_CohoFRAMdatabase_distribution.mdb
For more about the Regional Mark Information System (RMIS), see https://www.rmpc.org/.
rmis_framrmis_fram
## 'rmis_fram' A data frame with 225,390 rows and 4 columns:
RMIS PSC Recovery Location
Gear Code
FRAM fishery ID
FRAM fishery name
<https://github.com/FRAMverse/framr/blob/master/xlsx/lu_coho.xlsx
Mapping of stock_id to stock name for Chinook salmon, taken from the 'Stock' table of the Chinook FRAM database.
stock_chinook_framstock_chinook_fram
A data frame with 78 rows and 7 columns:
Species name
Chinook stock id number in FRAM
Chinook stock name in FRAM
'stock_name' but more human readable
2024 Pre-Season Chinook DB.mdb
Mapping of stock_id to stock name for Coho salmon, taken from the 'Stock' table of the Coho FRAM database.
stock_coho_framstock_coho_fram
A data frame with 78 rows and 7 columns:
Species name
Coho stock id number in FRAM
Coho stock name in FRAM
'stock_name' but more human readable
2024NOF_CohoFRAMdatabase_distribution.mdb
Mapping of timestep numbers to dates in the year, taken from the 'TimeStep' table of the Chinook FRAM database
timestep_chinook_framtimestep_chinook_fram
A data frame with 4 rows and 5 columns:
Species name
id number for the time step
Span of each timestep. Timesteps start on the first of the month, and end on the last of the month. Note that 'Oct-Apr-2' is highlighting that timestep 4 runs from October of the current year to April of the NEXT year (equivalent to timestep 1 of the following year).
'time_step_name', but months are written out
2024 Pre-Season Chinook DB.mdb
Mapping of timestep numbers to dates in the year, taken from the 'TimeStep' table of the Chinook FRAM database
timestep_coho_framtimestep_coho_fram
A data frame with 5 rows and 5 columns:
Species name
id number for the time step
Span of each timestep. Timesteps start on the first of the month, and end on the last of the month.
'time_step_name', but months are written out consistently
2024NOF_CohoFRAMdatabase_distribution.mdb
Lookup table for FRAM to TOCAS
tocas_framtocas_fram
## 'tocas_fram' A data frame with 10,462 rows and 6 columns:
1 = Non-Treaty / 2 = Treaty
Gear Code
Dispostion. "COMM" = Commercial, "C&SF" = Ceremonial and Subsistence fishing, "ORGN" = , "Test" and "TEST" = Test fishery (?), TKHM = ??
Catch area code, not zero-padded
FRAM fishery ID
FRAM fishery name
<https://github.com/FRAMverse/framr/blob/master/xlsx/lu_coho.xlsx
Lookup table for FRAM to WAFT
waft_framwaft_fram
## 'waft_fram' A data frame with 10,462 rows and 6 columns:
1 = Non-Treaty / 2 = Treaty
Gear Code
Dispostion. "COMM" = Commercial, "C&SF" = Ceremonial and Subsistence fishing, "ORGN" = , "Test" and "TEST" = Test fishery (?), TKHM = ??
Catch area code, zero-padded
FRAM fishery ID
FRAM fishery name
<https://github.com/FRAMverse/framr/blob/master/xlsx/lu_coho.xlsx