Skip to contents

Download depredation events in CSV, JSON, or Parquet format. Filters are the same as dep_read_events().

Usage

dep_share_events(
  format = c("csv", "json", "parquet"),
  id = NULL,
  unique_id = NULL,
  status = NULL,
  source = NULL,
  reason = NULL,
  confidence = NULL,
  place = NULL,
  predator = NULL,
  prey = NULL,
  reported_at = NULL,
  happened_at = NULL,
  predator_group_name = NULL,
  includes = NULL,
  dry_run = FALSE,
  verbosity = 0
)

Arguments

format

Character. Export format: "csv", "json", or "parquet".

id

Integer vector. Filter by event ID(s).

unique_id

Character vector. Filter by unique event identifier(s).

status

Character vector. Filter by event status. See dep_event_statuses() for valid values.

source

Character. Filter by event source.

reason

Character vector. Filter by reason. See dep_reasons().

confidence

Character vector. Filter by confidence level. See dep_confidence().

place

Character. Filter by place name (partial match).

predator

Character. Filter by predator species name.

prey

Character. Filter by prey species name.

reported_at

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

happened_at

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

predator_group_name

Character. Filter by predator group (pack) name. Accepts comma-separated names.

includes

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

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

The parsed export data, or the raw response if dry_run is TRUE.