Skip to contents

Get structured summary of a sightability model fit via API

Source: R/sight_fit_summary.R
sight_fit_summary.Rd

Calls the sightability API to fit a model and return a concise structured overview including model metadata, data summaries, covariate distributions, detection probability summaries, and final estimates.

Usage

sight_fit_summary(
  species,
  spatial_focus,
  bio_year,
  analysis_unit,
  survey_type,
  model,
  ...
)

sight_fit_summary_id(
  species_id,
  spatial_focus,
  bio_year,
  analysis_unit_id,
  survey_type_id,
  model_id,
  dry_run = FALSE,
  ...
)

Arguments

species

Character. Species name.

spatial_focus

Character. One of "DAU", "GMU", or "SubUnit".

bio_year

Integer. Biological year.

analysis_unit

Character. Analysis unit name.

survey_type

Character. Survey type name.

model

Character. Model name.

...

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

species_id

Integer. Species identifier.

analysis_unit_id

Integer. Analysis unit identifier.

survey_type_id

Integer. Survey type identifier.

model_id

Integer. Sightability model identifier.

dry_run

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

Value

List containing:

  • species_id, bio_year, analysis_unit_id, spatial_focus, survey_type_id, model_id: Input parameters

  • model: List with id, name, type, and covariates

  • data_summary: List with n_observations, n_strata, and strata tibble

  • covariate_summary: Named list of covariate distributions (NULL for JAGS models)

  • detection_summary: Detection probability distribution (NULL for JAGS models)

  • est: Estimates tibble matching sight_fit_model() output

See also

lkup_species_id(), lkup_dau_id(), lkup_survey_type_id(), lkup_model_id() for converting names to IDs

Examples

if (FALSE) { # \dontrun{
# Using names
sight_fit_summary(
  species = "Mule Deer",
  spatial_focus = "DAU",
  bio_year = 2024,
  analysis_unit = "North Converse 755",
  survey_type = "Sightability",
  model = "Mule Deer"
)

# Using IDs
sight_fit_summary_id(
  species_id = 1,
  spatial_focus = "DAU",
  bio_year = 2024,
  analysis_unit_id = 355,
  survey_type_id = 9,
  model_id = 1
)
} # }