SHARK4R (version 1.1.0)

load_shark4r_stats: Load SHARK4R statistics from GitHub

Description

This function downloads and loads precomputed SHARK4R statistical data (e.g., threshold or summary statistics) directly from the SHARK4R-statistics GitHub repository. The data are stored as .rds files and read into R as objects.

Usage

load_shark4r_stats(file_name = "sea_basin.rds", verbose = TRUE)

Value

An R object (typically a tibble or data.frame) read from the specified .rds file.

Arguments

file_name

Character string specifying the name of the .rds file to download. Defaults to "sea_basin.rds".

verbose

Logical; if TRUE (default), prints progress messages during download and loading.

Details

The function retrieves the file from the GitHub repository’s data/ folder. It temporarily downloads the file to the local system and then reads it into R using readRDS().

If the download fails (e.g., due to a network issue or invalid filename), the function throws an error with a descriptive message.

See Also

check_outliers for detecting threshold exceedances using the loaded statistics, get_shark_statistics for generating and caching statistical summaries used in SHARK4R. scatterplot for generating interactive plots with threshold values.

Examples

# \donttest{
# Load the default SHARK4R statistics file
try(stats <- load_shark4r_stats(verbose = FALSE))
if (exists("stats")) print(stats)

# Load a specific file
try(thresholds <- load_shark4r_stats("scientific_name.rds", verbose = FALSE))
if (exists("thresholds")) print(thresholds)
# }