Skip to contents

Read aerial survey entries

Source: R/sight_entries.R
sight_read_entries.Rd

Read aerial survey entries, optionally filtering by various parameters. An entry is synonymous with an observation or the records of animal sightings collected during the survey.

Usage

sight_read_entries(
  species = NULL,
  survey_type = NULL,
  analysis_unit = NULL,
  management_unit = NULL,
  stratum = NULL,
  bio_year = NULL,
  is_target_species = NULL,
  is_selected = NULL,
  is_surveyed = NULL,
  sort = NULL,
  pages = list(omit = 1),
  includes = NULL,
  appends = NULL,
  dry_run = FALSE,
  ...
)

sight_read_entries_id(
  species_id = NULL,
  survey_type_id = NULL,
  analysis_unit_id = NULL,
  management_unit_id = NULL,
  stratum_id = NULL,
  bio_year = NULL,
  is_target_species = NULL,
  is_selected = NULL,
  is_surveyed = NULL,
  sort = NULL,
  pages = list(omit = 1),
  includes = NULL,
  appends = NULL,
  dry_run = FALSE,
  ...
)

Arguments

species

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

survey_type

the name of the survey type, for example "Sightability"

analysis_unit

the name of the analysis unit

management_unit

the name of the game management unit

stratum

the name of the stratum, for example "High"

bio_year

the biological year the survey was conducted in, for example the winter of 2022-2023 would be 2022

is_target_species

logical, when TRUE only observations of the focal species of the survey are returned

is_selected

logical, when TRUE only observations in selected subunits are returned

is_surveyed

logical, when TRUE only observations in surveyed subunits are returned

sort

a named list of sorting options

pages

a named list with pagination options, see details

includes

a character vector of related resources to include, see details

appends

a character vector of fields to append to each entry, see details

dry_run

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

...

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

species_id

the ID of the species

survey_type_id

the ID of the survey type

analysis_unit_id

the ID of the analysis unit

management_unit_id

the ID of the game management unit

stratum_id

the ID of the stratum

Value

A tibble with one row per observation. Key columns:

entry_id

Integer. Unique identifier for the observation.

survey_id, design_id

Integer. Parent survey and design identifiers.

species_id, species

Species identifier and name.

survey_type_id

Integer. Survey type identifier.

bio_year

Integer. Biological year.

date

Character. Date of observation.

analysis_unit_id, analysis_unit

Analysis unit (DAU) identifier and name.

management_unit_id, management_unit

Management unit (GMU) identifier and name.

subunit_id, subunit

Subunit identifier and name.

stratum_id, stratum

Stratum identifier and name.

is_selected, is_surveyed

Logical. Whether the subunit was selected/surveyed.

total, males, females, youngs, unclass

Integer. Count columns.

activity

Character. Animal activity (e.g., "Moving", "Bedded").

vegetation_type, screen_type

Character. Habitat covariates.

snow_percentage, screen_percentage

Integer. Covariate percentages (0–100).

metadata

List column. Nested tibble with additional observation attributes.

latitude, longitude

Numeric. Observation coordinates.

Details

The pages argument is a named list with the following options:

  • omit: page number to omit, default is 1 which returns all records

  • size: number of records to return

  • number: the page number to return given the size

The includes argument is a character vector of related resources to include. Valid values are:

  • aerialSurvey: include aerial survey details

  • subunit: include subunit details

  • species: include species details

The appends argument is a character vector of fields to append to each entry. Valid values are:

  • polygon: append the geometry of the entry in WGS 84 (EPSG 4326)

See also

lkup_species_id(), lkup_survey_type_id(), lkup_dau_id(), lkup_gmu_id(), lkup_strata_id() for converting names to IDs

Examples

if (FALSE) { # \dontrun{
# Read all mule deer entries in 2022
sight_read_entries(species = "Mule Deer", bio_year = 2022)

# Read all mule deer entries in GMU 61 in 2022
sight_read_entries(
  species = "Mule Deer",
  management_unit = "61",
  bio_year = 2022
)

} # }