Skip to contents

Retrieve marine biotoxin data from IOC-UNESCO Toxins Database

Source: R/hab_api_functions.R
get_toxin_list.Rd

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.

See also

https://toxins.hais.ioc-unesco.org/api/toxins/ for IOC-UNESCO Toxins Database.

Examples

if (FALSE) { # \dontrun{
# 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)
} # }