Read depredation animals

Retrieve individual animal records from the telemetry API. Animals are victims documented within an investigation. All filter parameters are optional; omit them to return all animal records.

Usage

dep_read_animals(
  id = NULL,
  event_id = NULL,
  species = NULL,
  sex = NULL,
  state = NULL,
  attacked_by = NULL,
  analysis_unit_id = NULL,
  management_unit_id = NULL,
  attacked_at = NULL,
  died_at = NULL,
  includes = NULL,
  page_args = list(),
  dry_run = FALSE,
  verbosity = 0
)

Arguments

id

Integer vector. Filter by animal record ID(s).

event_id

Integer vector. Filter by parent event ID(s).

species

Character. Filter by species name.

sex

Character. Filter by sex.

state

Character vector. Filter by animal state. See dep_animal_states().

attacked_by

Character. Filter by predator species.

analysis_unit_id

Integer. Filter by analysis unit (DAU) ID.

management_unit_id

Integer. Filter by management unit (GMU) ID.

attacked_at

Character. Filter by attack date (e.g. "2024-01-01,2024-12-31" for a range).

died_at

Character. Filter by death date (same range format).

includes

Character vector of related resources to include in the response. Valid values: "calls", "investigations", "animals", "group".

page_args

List of pagination arguments passed to spdgt.auth::api_get().

dry_run

Logical. If TRUE, prints the request without sending it.

verbosity

Integer. How much information to print (0 = silent, 1 = headers, 2 = headers + body, 3 = full).

Value

A tibble of animal records.