rcatfish_references: Search for references in Eschmeyer's Catalog of Fishes

View source: R/rcatfish_references.R

rcatfish_referencesR Documentation

Search for references in Eschmeyer's Catalog of Fishes

Description

Search for references in the Catalog of Fishes by keyword or reference number.

Usage

rcatfish_references(query, type, sleep.time = 10, verbose = TRUE)

Arguments

query

Either a character vector of keywords to search for or a numeric vector with reference numbers

type

Either "RefNo" if searching for a reference number or "keyword" if searching by keywords reference numbers.

sleep.time

Numeric. Time in seconds to sleep between query calls to the California Academy of Sciences page. This is set by default to 10 seconds, which is in their robots.txt. Adjust at your own risk.

verbose

Logical. Should query progress be messaged to the screen? Default is TRUE.

Details

This function searches Catalog of Fishes references. Users can supply either a keyword (i.e. cichlidae, revision, etc.) or a reference number to retrieve reference information.

Value

A data.frame containing columns for the query, reference number, and full citation.

Author(s)

Samuel R. Borstein, Brian C. O'Meara

References

Fricke, R. (Year Accessed). Eschmeyer's Catalog of Fishes: References. https://researcharchive.calacademy.org/research/ichthyology/catalog/fishcatmain.asp

Examples

#Perform a search of references that contain the keyword Amphilophus.
my.refs<-rcatfish_references(query = "Amphilophus", type = "keyword")
#Perform a search of references based on a Catalog of Fishes reference number
my.refs<-rcatfish_references(query = 2787, type = "RefNo")

rcatfish documentation built on Feb. 3, 2026, 5:07 p.m.