faoareas: faoareas

In rfishbase: R Interface to 'FishBase'

faoareas

Description

return a table of species locations as reported in FishBASE.org FAO location data

Usage

faoareas(
  species_list = NULL,
  fields = NULL,
  server = getOption("FISHBASE_API", "fishbase"),
  version = get_latest_release(),
  db = default_db(),
  ...
)

Arguments

species_list	A vector of scientific names (each element as "genus species"). If empty, a table for all fish will be returned.
fields	a character vector specifying which fields (columns) should be returned. By default, all available columns recognized by the parser are returned. Mostly for backwards compatibility as users can subset by column later
server	can be set to either "fishbase" or "sealifebase" to switch between databases. NOTE: it is usually easier to leave this as NULL and set the source instead using the environmental variable 'FISHBASE_API', e.g. 'Sys.setenv(FISHBASE_API="sealifebase")'.
version	a version string for the database, will default to the latest release. see [get_releases()] for details.
db	the
...	unused; for backwards compatibility only

Details

currently this is ~ FAO areas table (minus "note" field) e.g. http://www.fishbase.us/Country/FaoAreaList.php?ID=5537

Value

a tibble, empty tibble if no results found

Examples

## Not run: 
  faoareas()

## End(Not run)

rfishbase documentation built on March 7, 2023, 7:23 p.m.