naming-conventions
naming-conventions.Rmd
General naming conventions that are held through this package (and the groundfishr
package):
Functions
Fisheries are identified with fsh
followed by a number - fsh1
, fsh2.
Trawl survey functions start with ts_
, longline survey functions start with lls
.
A function that starts with q_
is a database query that will connect to either the AKFIN or AFSC database for raw data. Since queries may be specific for each species or region, stand alone query “wrapper functions” are provided. These functions are named by region and species a la goa_nork()
for Gulf of Alaska northern rockfish.
Data files
A data file name that ends with _data.csv
is the raw data that originates from the database with no or little filtering. Query functions place files in the data/raw
folder.
Any user provided files needed (age error, length bins, VAST) should be stored in the data/user_input
folder as .csv files.