getAbundance {vectorsurvR} | R Documentation |
Calculate abundance
Description
Calculates abundance
Usage
getAbundance(
collections,
interval,
agency = NULL,
species = NULL,
trap = NULL,
sex = "female",
trapnight_min = 1,
trapnight_max = NULL,
separate_by = NULL
)
Arguments
collections |
Collections data retrieved from getArthroCollections() |
interval |
Calculation interval for abundance, accepts "CollectionDate",“Week”, “Biweek”, or “Month. |
agency |
An optional vector for filtering agency by character code |
species |
An optional vector for filtering species. Species_display_name is the accepted notation.To see a list of species present in your data run unique(collections$species_display_name). If species is unspecified, the default NULL will return data for all species in data. |
trap |
An optional vector for filtering trap type by acronym. Trap_acronym is the is the accepted notation. Run unique(collections$trap_acronym) to see trap types present in your data. If trap is unspecified, the default NULL will return data for all trap types. |
sex |
An optional vector for filtering sex type. Accepts 'male', 'female',or 'other'. If sex is unspecified, the default NULL will return data for female sex. |
trapnight_min |
Minimum trap night restriction for calculation. Default is 1. |
trapnight_max |
Maximum trap night restriction for calculation. Default is no restriction. |
separate_by |
Separate/group the calculation by 'trap','species', 'agency', 'county', or 'spatial_feature'. Default NULL does not separate. |
Value
A dataframe of abundance calculations.
Examples
getAbundance(sample_collections,
interval = 'Week',
species = list('Cx pipiens'),
trap = list('GRVD', 'CO2'),
sex = list("female"),
trapnight_min = 1,
trapnight_max = 5,
separate_by = "species")