common_names: common names

Description Usage Arguments Details Value

View source: R/common_names.R

Description

Return a table of common names

Usage

1
2
3
4
5
6
7
8
common_names(
  species_list = NULL,
  server = getOption("FISHBASE_API", "fishbase"),
  version = get_latest_release(),
  db = default_db(),
  Language = "English",
  fields = NULL
)

Arguments

species_list

A vector of scientific names (each element as "genus species"). If empty, a table for all fish will be returned.

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

Language

a string specifying the language for the common name, e.g. "English"

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

Details

Note that there are many common names for a given sci name, so sci_to_common doesn't make sense

Value

a data.frame of common names by species queried. If multiple species are queried, The resulting data.frames are concatenated.


rfishbase documentation built on Dec. 14, 2021, 5:07 p.m.