Skip to contents

Retrieve Species List from the Global Archive API

ga_api_species_list.Rd

This function retrieves the species list from GlobalArchive by making an API call. The data is returned as a data frame with relevant species information, excluding some columns that are not needed for further analysis.

Usage

ga_api_species_list(username, password)

Arguments

username

A character string representing your GlobalArchive username for API authentication.

password

A character string representing your GlobalArchive password for API authentication.

Value

A data frame containing the species list from GlobalArchive. The data frame includes the following columns:

  • subject: The URL or identifier of the species in GlobalArchive.

  • australian_common_name: Common name of the species.

  • family: The family of the species.

  • genus: The genus of the species.

  • species: The species name.

  • caab: The CAAB (Codes for Australian Aquatic Biota) code.

  • other_columns: Any other relevant columns included in the original dataset.

Examples

if (FALSE) { # \dontrun{
# Fetch the species list from GlobalArchive
species_list <- ga_api_species_list("your_username", "your_password")

# Display the first few rows of the species list
head(species_list)
} # }