rnpn (version 1.3.0)

npn_get_phenophases_for_taxon: Get Phenophases for Taxon

Description

This function gets a list of phenophases that are applicable for a provided taxonomic grouping, e.g. family, order. Note that since a higher taxononmic order will aggregate individual species not every phenophase returned through this function will be applicable for every species belonging to that taxonomic group.

Usage

npn_get_phenophases_for_taxon(
  family_ids = NULL,
  order_ids = NULL,
  class_ids = NULL,
  genus_ids = NULL,
  date = NULL,
  return_all = 0,
  ...
)

Value

A data frame listing phenophases in the NPN database for the specified taxon and date.

Arguments

family_ids

Integer vector of taxonomic family ids to search for.

order_ids

Integer vector of taxonomic order ids to search for.

class_ids

Integer vector of taxonomic class ids to search for

genus_ids

Integer vector of taxonomic genus ids to search for

date

Specify the date of interest. For this function to return anything, either this value must be set or return_all must be 1.

return_all

Takes either 0 or 1 as input and defaults to 0. For this function to return anything, either this value must be set to 1 or date must be set.

...

Currently unused.

Details

It's also important to note that phenophase definitions can change for individual species over time, so there's a need to specify either a date of interest, or to explicitly state that the function should return all phenophases that were ever applicable for any species belonging to the specified taxonomic group.

When called, this function requires of these three parameters, exactly one of family_ids, order_ids or class_ids to be set.

Examples

if (FALSE) {
npn_get_phenophases_for_taxon(class_ids = c(5, 6), date = "2018-05-05")
npn_get_phenophases_for_taxon(family_ids = c(267, 268), date = "2018-05-05")

#if you supply two or more "ids" arguments, the highest classification takes precedence
pheno <- npn_get_phenophases_for_taxon(
  class_ids = 4,
  family_ids = c(103, 104),
  genus_ids = c(409, 957, 610),
  date = "2018-05-05"
)

colnames(pheno)
# [1] "family_id"   "family_name" "phenophases"
}