getBirds: getBirds

getBirdsR Documentation

getBirds

Description

Returns bird monitoring data from the Birds slot of an NCRNbirds object.

Usage

getBirds(
  object,
  points = NA,
  AOU = NA,
  years = NA,
  min.count = NA,
  max.count = NA,
  band = NA,
  interval = NA,
  visits = NA,
  times = NA,
  reps = NA,
  flyover = FALSE,
  gender = NA,
  first3min = FALSE,
  incidental = FALSE,
  juvenile = FALSE,
  output = "dataframe"
)

Arguments

object

An NCRNbirds object or a list of such objects.

points

A character vector. The names of one or more points where the data was collected.

AOU

A character vector. One or more AOU (American Onothological Union) codes of bird species.

years

A vector of numbers. Will return only data from the indicated years.

min.count

A numeric vector of length one. Will only return data with a bird count equal to or geater than min.count

max.count

A numeric vector of length one. Will only return data with a bird count equal to or less than max.count

band

A numeric vector. Only observations whose Distance_id field matches a value in band will be returned. NA returns all bands.

interval

A numeric vector. Only observations whose Interval field matches a value in interval will be returned.

visits

A length 1 numeric vector, defaults to NA. Returns data only from the indicated visits.

times

A numeric vector of length 1. Returns only data from points where the number of years that a point has been visited is greater or equal to the value of times. This is determined based on the data found in the Visits slot.

reps

A numeric vector of length 1. Defaults to NA. Returns only data from points where the number of years that a point has been visited is greater or equal to the valuemax,site,dist,wind,sky, of times. This is determined based on the data found in the Visits slot.

flyover

Logical. TRUE to include flyovers in count data. Defaults to FALSE.

gender

Character. Defaults to selecting all detected individuals. Options to filter by gender are "Male", "Female", "Undetermined".

first3min

Logical. If TRUE, only returns detections within first 3 minutes of the timed count. Defaults to selecting counts from all timed intervals.

incidental

Logical. TRUE to include incidental observations in count data. Defaults to FALSE.

juvenile

Logical. TRUE to include observations of juvenile birds in count data. Defaults to FALSE.

output

Either "dataframe" (the default) or "list". Note that this must be in quotes. Determines the type of output from the function.

Details

Returns the data from the Birds slot of a single NCNRbirds object or a list of such objects. The data can be filtered using the various arguments. The default output is adata.frame. However, if object is a list and output is "list" then a list of data.frames will be returned.


NCRN/NCRNbirds documentation built on Aug. 28, 2023, 12:12 p.m.