get_toxin_list: Retrieve Toxin Data from IOC-UNESCO Toxins Database

View source: R/hab_api_functions.R

get_toxin_listR Documentation

Retrieve Toxin Data from IOC-UNESCO Toxins Database

Description

This function collects data from the IOC-UNESCO Toxins Database and returns information about toxins.

Usage

get_toxin_list(return_count = FALSE)

Arguments

return_count

Logical. If TRUE, the function returns the count of toxins available in the database. If FALSE (default), it returns detailed toxin data.

Value

If return_count = TRUE, the function returns a numeric value representing the number of toxins in the database. Otherwise, it returns a list of toxins with detailed information.

Examples

## Not run: 
# Retrieve the full list of toxins
toxin_list <- get_toxin_list()

# Retrieve only the count of toxins
toxin_count <- get_toxin_list(return_count = TRUE)

## End(Not run)


sharksmhi/SHARK4R documentation built on Jan. 9, 2025, 5:15 p.m.