Skip to contents

Returns interactions involving specific taxa. Secondary (target) taxa and spatial boundaries may also be set

Usage

get_interactions_by_taxa(
  sourcetaxon,
  targettaxon = NULL,
  interactiontype = NULL,
  accordingto = NULL,
  showfield = c("source_taxon_external_id", "source_taxon_name", "source_taxon_path",
    "source_specimen_life_stage", "interaction_type", "target_taxon_external_id",
    "target_taxon_name", "target_taxon_path", "target_specimen_life_stage", "latitude",
    "longitude", "study_citation", "study_external_id", "study_source_citation"),
  otherkeys = NULL,
  bbox = NULL,
  returnobservations = F,
  opts = list(),
  read_csv = read_csv_online
)

Arguments

sourcetaxon

Taxa of interest (consumer, predator, parasite); may be specified as "Genus species" or higher level (e.g., Genus, Family, Class).

targettaxon

Taxa of interest (prey, host); may be specified as "Genus species" or higher level (e.g., Genus, Family, Class)

interactiontype

Interaction types of interest (prey, host); may be specified as listed by get_interaction_types()

accordingto

Data source of interest

showfield

Data fields of interest (e. g. source_taxon_external_id, source_taxon_name); may be specified as listed by get_data_fields()

otherkeys

list of key-value pairs to query any field not covered by other parameters; keys may be specified as listed by get_data_fields()

bbox

Coordinates in EPSG:4326 decimal degrees defining "left, bottom, right, top" of bounding box

returnobservations

if true, all individual observations are returned, else only distinct relationships

opts

list of named options to configure GloBI API

read_csv

function used to find csv associated to query url, defaulting to online query method

Value

Returns data frame of interactions

Note

For data sources in which type of interactions were not specified, the interaction is labeled "interacts_with"

Examples

if (FALSE) {
get_interactions_by_taxa(sourcetaxon = "Rattus")
get_interactions_by_taxa(sourcetaxon = "Aves", targettaxon = "Rattus")
get_interactions_by_taxa(sourcetaxon = "Rattus rattus",
bbox = c(-67.87,12.79,-57.08,23.32))
}