SHARK4R (version 1.1.0)

get_shark_options: Retrieve available search options from SHARK

Description

The get_shark_options() function retrieves available search options from the SHARK database. It sends a GET request to the SHARK API and returns the results as a structured named list.

Usage

get_shark_options(prod = TRUE, utv = FALSE, unparsed = FALSE)

Value

A named list of available search options from the SHARK API. If unparsed = TRUE, returns the raw JSON structure as a list.

Arguments

prod

Logical value that selects the production server when TRUE and the test server when FALSE, unless utv is TRUE.

utv

Logical value that selects the UTV server when TRUE.

unparsed

Logical. If TRUE, returns the complete JSON response as a nested list without parsing. Defaults to FALSE.

Details

This function sends a GET request to the /api/options endpoint of the SHARK API to retrieve available search filters and options that can be used in SHARK data queries.

See Also

get_shark_data() for retrieving actual data from the SHARK API.

https://shark.smhi.se/en for the SHARK database portal.

Examples

# \donttest{
  # Retrieve available search options (simplified)
  try(shark_options <- get_shark_options())
  if (exists("shark_options")) names(shark_options)

  # Retrieve full unparsed JSON response
  try(raw_options <- get_shark_options(unparsed = TRUE))

  # View available datatypes
  if (exists("shark_options")) print(shark_options$dataTypes)
# }