get_landings_length: Extract landings data by length from ADIOS! (help from CFDBS)

In andybeet/cfdbs: Pulls data from the NEFSC commercial database

Extract landings data by length from ADIOS! (help from CFDBS)

Description

Extract landings information by length (len,numlen,spplndlb) in cm/lbs from ADIOS! (mv_cf_len). This function requires no knowledge of sql. For direct sql usage please see get_anything_sql function

Usage

get_landings_length(
  channel,
  area = "all",
  gear = "all",
  year = 1994,
  species = "all",
  species_itis = FALSE
)

Arguments

channel	DBI Object. Inherited from DBIConnection-class. This object is used to connect to communicate with the database engine. (see connect_to_database)
species	Numeric vector. Species codes (nespp3 or species_itis)
species_itis	Boolean. Indicating if species values are nespp3 (FALSE) or species_itis (TRUE).Default = FALSE
areas	Numeric vector. Statistical areas (area)
gears	Numeric vector. Gear types (negear2)
years	Numeric vector. containing the years to search over

Value

A list is returned:

data containing the result of the data pull ( year, month, day, permit, qtr, negear, negear2, nespp3, nespp4, species_itis, market_code, area, spplndlb, length, numlen, numsamp, sex )

sql the resulting sql statement based on user input

colNames a vector of the table's column names

Reference

Use the data dictionary (http://nova.nefsc.noaa.gov/datadict/) for field name explanations

Warning

You will need to obtain read only privilages to access ADIOS! The ADIOS landings by length database (MV_CF_LEN) contains 1.3 million records. If you try to pull the entire database you may suffer from memory issues.

See Also

connect_to_database

Other get functions: get_age_length(), get_anything_sql(), get_areas(), get_gears(), get_landings_palmer(), get_landings(), get_locations(), get_ports(), get_species_itis(), get_species(), get_vessels()

Examples

## Not run: 

# extracts landings by length for cod (081) in area 500 using  gear types (1,2,10)
channel <- connect_to_database(server="name_of_server",uid="individuals_username")

get_landings_length(channel,area=c(500,600),gear=c(1,2,10),year=c(1999),species=81)

## End(Not run)

andybeet/cfdbs documentation built on Sept. 19, 2023, 9:34 p.m.