Skip to contents

Check API connectivity and package setup

Source: R/sight_check_api.R
sight_check_api.Rd

Runs a series of diagnostic checks to verify that the package is properly configured and can communicate with the SpeedGoat APIs.

Usage

sight_check_api(verbose = TRUE)

Arguments

verbose

Logical. If TRUE (default), prints detailed status messages.

Value

A list with check results (invisibly), with components:

  • authenticated: logical

  • counts_api: logical

  • counts_data: logical

  • sightability_api: logical

  • errors: character vector of any error messages

Details

This function checks:

  • Authentication status

  • Counts API connectivity (species lookup)

  • Counts API data access (survey summaries)

  • Sightability API connectivity (if available)

Use this function to troubleshoot connectivity issues or verify that your setup is working correctly.

Examples

if (FALSE) { # \dontrun{
# Run diagnostics
sight_check_api()

# Capture results without printing
results <- sight_check_api(verbose = FALSE)
} # }