Read saved IPM inputs

Retrieves previously saved input estimates from the Counts API. Useful for viewing historical results across years. Joins parameter and model names from the lookup cache. This function is not restricted to only sightability or composition parameter types.

Usage

sight_read_estimates(
  species = NULL,
  analysis_unit = NULL,
  year = NULL,
  parameter = NULL,
  pages = list(omit = 1),
  ...
)

sight_read_estimates_id(
  species_id = NULL,
  analysis_unit_id = NULL,
  year = NULL,
  parameter_id = NULL,
  pages = list(omit = 1),
  dry_run = FALSE,
  ...
)

Arguments

species

the common name of the species, for example "Mule Deer"

analysis_unit

the name of the analysis unit (DAU)

year

optional biological year to filter on

parameter

optional IPM parameter name to filter on (e.g., "Abundance"). Requires species. Use lkup_ipm_param_opts() to see available parameters for a species.

pages

a named list with pagination options, see sight_read_entries() for details

...

Additional arguments passed to the underlying spdgt.auth function (e.g., verbosity, timeout).

species_id

the ID of the species

analysis_unit_id

the ID of the analysis unit (DAU)

parameter_id

optional IPM parameter ID to filter on

dry_run

If TRUE, print the HTTP request without sending it and return the request object invisibly. Useful for debugging.

Value

A tibble of saved estimate records with parameter_name and model_name columns joined from lookup cache

Examples

if (FALSE) { # \dontrun{
# By name
sight_read_estimates(species = "Mule Deer", analysis_unit = "DAU 350")

# Filter by parameter name
sight_read_estimates(
  species = "Mule Deer",
  analysis_unit = "DAU 350",
  parameter = "Total Abundance"
)

# By ID
sight_read_estimates_id(species_id = 1L, analysis_unit_id = 350L)

# Filter to a specific year
sight_read_estimates_id(
  species_id = 1L,
  analysis_unit_id = 350L,
  year = 2024
)
} # }