dietSummary: Flexible diet summary function

Description Usage Arguments Examples

View source: R/dietSummary.r

Description

This function provides a summary of quantitative diet data for a given bird species, taxonomic level of prey resolution, data type, season, region, and year range

Usage

1
2
3
4
5
6
7
8
9
dietSummary(
  commonName,
  by = "Order",
  dietType = "Items",
  season = NULL,
  region = NULL,
  yearRange = c(1700, 2100),
  db = NULL
)

Arguments

commonName

common name of bird species to summarize; case-insensitive.

by

taxonomic level of prey to summarize diet by; possibile values include 'Kingdom', 'Phylum', 'Class', 'Order', 'Family', 'Genus', or 'Species'; defaults to 'Order'.

dietType

the type of quantitative diet data; possible values include percent by 'Items', 'Wt_or_Vol' (weight or volume), or percent 'Occurrence'; defaults to 'Items'.

season

the season for which a diet summary should be conducted; possible values include 'spring', 'summer', 'fall', 'winter', or 'any'; defaults to 'any'.

region

the region for which a diet summary should be conducted; typically these are US or Mexican state or Canadian province names.

yearRange

a vector specifying the minimum and maximum years over which a diet summary should be conducted; by default all years will be included.

db

used to specify an alternative Diet Database object, mainly for testing; the default results in the main 'dietdb' data object being used.

Examples

1
2
dietSummary("Bald Eagle")
dietSummary("Bald Eagle", by = "Class", season = "winter", dietType = "Items", yearRange = c(1985, 2000))

ahhurlbert/aviandietdb documentation built on Oct. 12, 2021, 5:20 p.m.