references {rfishbase}

references

Description

references

Usage

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

Arguments

codes

One or more Fishbase reference numbers, matching the RefNo field

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

Value

a tibble (data.frame) of reference data

Examples

## Not run: 
references(codes = 1)
references(codes = 1:6)
references(codes = 1:6, fields = c('Author', 'Year', 'Title'))
references() # all references

## End(Not run)