Learn R Programming
⚠️There's a newer version (0.9.100.1) of this package.Take me there.

taxize

taxize allows users to search over many taxonomic data sources for species names (scientific and common) and download up and downstream taxonomic hierarchical information - among other things.

The taxize tutorial is can be found at https://ropensci.org/tutorials/taxize.html

The functions in the package that hit a specific API have a prefix and suffix separated by an underscore. They follow the format of service_whatitdoes. For example, gnr_resolve uses the Global Names Resolver API to resolve species names. General functions in the package that don't hit a specific API don't have two words separated by an underscore, e.g., classification.

You need API keys for Encyclopedia of Life (EOL), Tropicos, IUCN, and NatureServe.

SOAP

Note that a few data sources require SOAP web services, which are difficult to support in R across all operating systems. These include: Pan-European Species directories Infrastructure and Mycobank. Data sources that use SOAP web services have been moved to taxizesoap at https://github.com/ropensci/taxizesoap.

Currently implemented in taxize

**: There are none! We suggest using TPL and TPLck functions in the taxonstand package. We provide two functions to get bulk data: tpl_families and tpl_get.

***: There are none! The function scrapes the web directly.

May be in taxize in the future...

See the newdatasource tag in the issue tracker

Tutorial

For more examples see the tutorial

Installation

Stable version from CRAN

install.packages("taxize")

Development version from GitHub

Windows users install Rtools first.

install.packages("devtools")
devtools::install_github("ropensci/taxize")
library('taxize')

Get unique taxonomic identifier from NCBI

Alot of taxize revolves around taxonomic identifiers. Because, as you know, names can be a mess (misspelled, synonyms, etc.), it's better to get an identifier that a particular data source knows about, then we can move forth acquiring more fun taxonomic data.

uids <- get_uid(c("Chironomus riparius", "Chaetopteryx"))

Retrieve classifications

Classifications - think of a species, then all the taxonomic ranks up from that species, like genus, family, order, class, kingdom.

out <- classification(uids)
lapply(out, head)
#> $`315576`
#>                 name         rank     id
#> 1 cellular organisms      no rank 131567
#> 2          Eukaryota superkingdom   2759
#> 3       Opisthokonta      no rank  33154
#> 4            Metazoa      kingdom  33208
#> 5          Eumetazoa      no rank   6072
#> 6          Bilateria      no rank  33213
#> 
#> $`492549`
#>                 name         rank     id
#> 1 cellular organisms      no rank 131567
#> 2          Eukaryota superkingdom   2759
#> 3       Opisthokonta      no rank  33154
#> 4            Metazoa      kingdom  33208
#> 5          Eumetazoa      no rank   6072
#> 6          Bilateria      no rank  33213

Immediate children

Get immediate children of Salmo. In this case, Salmo is a genus, so this gives species within the genus.

children("Salmo", db = 'ncbi')
#> $Salmo
#>    childtaxa_id                   childtaxa_name childtaxa_rank
#> 1       2126688              Salmo ciscaucasicus        species
#> 2       1509524  Salmo marmoratus x Salmo trutta        species
#> 3       1484545 Salmo cf. cenerinus BOLD:AAB3872        species
#> 4       1483130               Salmo zrmanjaensis        species
#> 5       1483129               Salmo visovacensis        species
#> 6       1483128                Salmo rhodanensis        species
#> 7       1483127                 Salmo pellegrini        species
#> 8       1483126                     Salmo opimus        species
#> 9       1483125                Salmo macedonicus        species
#> 10      1483124                Salmo lourosensis        species
#> 11      1483123                   Salmo labecula        species
#> 12      1483122                  Salmo farioides        species
#> 13      1483121                      Salmo chilo        species
#> 14      1483120                     Salmo cettii        species
#> 15      1483119                  Salmo cenerinus        species
#> 16      1483118                   Salmo aphelios        species
#> 17      1483117                    Salmo akairos        species
#> 18      1201173               Salmo peristericus        species
#> 19      1035833                   Salmo ischchan        species
#> 20       700588                     Salmo labrax        species
#> 21       237411              Salmo obtusirostris        species
#> 22       235141              Salmo platycephalus        species
#> 23       234793                    Salmo letnica        species
#> 24        62065                  Salmo ohridanus        species
#> 25        33518                 Salmo marmoratus        species
#> 26        33516                    Salmo fibreni        species
#> 27        33515                     Salmo carpio        species
#> 28         8032                     Salmo trutta        species
#> 29         8030                      Salmo salar        species
#> 
#> attr(,"class")
#> [1] "children"
#> attr(,"db")
#> [1] "ncbi"

Downstream children to a rank

Get all species in the genus Apis

downstream(as.tsn(154395), db = 'itis', downto = 'species', verbose = FALSE)
#> $`154395`
#>      tsn parentname parenttsn          taxonname rankid rankname
#> 1 154396       Apis    154395     Apis mellifera    220  species
#> 2 763550       Apis    154395 Apis andreniformis    220  species
#> 3 763551       Apis    154395        Apis cerana    220  species
#> 4 763552       Apis    154395       Apis dorsata    220  species
#> 5 763553       Apis    154395        Apis florea    220  species
#> 6 763554       Apis    154395 Apis koschevnikovi    220  species
#> 7 763555       Apis    154395   Apis nigrocincta    220  species
#> 
#> attr(,"class")
#> [1] "downstream"
#> attr(,"db")
#> [1] "itis"

Upstream taxa

Get all genera up from the species Pinus contorta (this includes the genus of the species, and its co-genera within the same family).

upstream("Pinus contorta", db = 'itis', upto = 'Genus', verbose=FALSE)
#>      tsn                        target
#> 1 183327                Pinus contorta
#> 2 183332 Pinus contorta ssp. bolanderi
#> 3 822698  Pinus contorta ssp. contorta
#> 4 183329 Pinus contorta ssp. latifolia
#> 5 183330 Pinus contorta ssp. murrayana
#> 6 529672 Pinus contorta var. bolanderi
#> 7 183328  Pinus contorta var. contorta
#> 8 529673 Pinus contorta var. latifolia
#> 9 529674 Pinus contorta var. murrayana
#>                                                        commonNames
#> 1               scrub pine,shore pine,tamarack pine,lodgepole pine
#> 2                                            Bolander's beach pine
#> 3                                                               NA
#> 4                         black pine,Rocky Mountain lodgepole pine
#> 5                              tamarack pine,Sierra lodgepole pine
#> 6                                              Bolander beach pine
#> 7                  coast pine,lodgepole pine,beach pine,shore pine
#> 8 tall lodgepole pine,lodgepole pine,Rocky Mountain lodgepole pine
#> 9      Murray's lodgepole pine,Sierra lodgepole pine,tamarack pine
#>      nameUsage
#> 1     accepted
#> 2 not accepted
#> 3 not accepted
#> 4 not accepted
#> 5 not accepted
#> 6     accepted
#> 7     accepted
#> 8     accepted
#> 9     accepted
#> Pinus contorta 
#>             NA 
#> attr(,"class")
#> [1] "upstream"
#> attr(,"db")
#> [1] "itis"

Get synonyms

synonyms("Acer drummondii", db="itis")
#>      tsn             target commonNames    nameUsage
#> 1 183671    Acer drummondii          NA not accepted
#> 2 183672 Rufacer drummondii          NA not accepted
#> $`Acer drummondii`
#> [1] NA
#> 
#> attr(,"class")
#> [1] "synonyms"
#> attr(,"db")
#> [1] "itis"

Get taxonomic IDs from many sources

get_ids(names="Salvelinus fontinalis", db = c('itis', 'ncbi'), verbose=FALSE)
#> $itis
#> Salvelinus fontinalis 
#>              "162003" 
#> attr(,"match")
#> [1] "found"
#> attr(,"multiple_matches")
#> [1] FALSE
#> attr(,"pattern_match")
#> [1] FALSE
#> attr(,"uri")
#> [1] "http://www.itis.gov/servlet/SingleRpt/SingleRpt?search_topic=TSN&search_value=162003"
#> attr(,"class")
#> [1] "tsn"
#> 
#> $ncbi
#> Salvelinus fontinalis 
#>                "8038" 
#> attr(,"class")
#> [1] "uid"
#> attr(,"match")
#> [1] "found"
#> attr(,"multiple_matches")
#> [1] FALSE
#> attr(,"pattern_match")
#> [1] FALSE
#> attr(,"uri")
#> [1] "https://www.ncbi.nlm.nih.gov/taxonomy/8038"
#> 
#> attr(,"class")
#> [1] "ids"

You can limit to certain rows when getting ids in any get_*() functions

get_ids(names="Poa annua", db = "gbif", rows=1)
#> $gbif
#> Poa annua 
#> "2704179" 
#> attr(,"class")
#> [1] "gbifid"
#> attr(,"match")
#> [1] "found"
#> attr(,"multiple_matches")
#> [1] TRUE
#> attr(,"pattern_match")
#> [1] FALSE
#> attr(,"uri")
#> [1] "http://www.gbif.org/species/2704179"
#> 
#> attr(,"class")
#> [1] "ids"

Furthermore, you can just back all ids if that's your jam with the get_*_() functions (all get_*() functions with additional _ underscore at end of function name)

get_ids_(c("Chironomus riparius", "Pinus contorta"), db = 'nbn', rows=1:3)
#> $nbn
#> $nbn$`Chironomus riparius`
#>               guid      scientificName    rank taxonomicStatus
#> 1 NBNSYS0000027573 Chironomus riparius species        accepted
#> 2 NHMSYS0001718585  Hypnoidus riparius species        accepted
#> 3 NBNSYS0000023345   Paederus riparius species        accepted
#> 
#> $nbn$`Pinus contorta`
#>               guid                scientificName    rank taxonomicStatus
#> 1 NBNSYS0000004786                Pinus contorta species        accepted
#> 2 NHMSYS0000494858 Pinus contorta var. murrayana variety        accepted
#> 3 NHMSYS0000494848  Pinus contorta var. contorta variety        accepted
#> 
#> 
#> attr(,"class")
#> [1] "ids"

Common names from scientific names

sci2comm('Helianthus annuus', db = 'itis')
#>      tsn                              target
#> 1  36616                   Helianthus annuus
#> 2 525928      Helianthus annuus ssp. jaegeri
#> 3 525929 Helianthus annuus ssp. lenticularis
#> 4 525930      Helianthus annuus ssp. texanus
#> 5 536095 Helianthus annuus var. lenticularis
#> 6 536096  Helianthus annuus var. macrocarpus
#> 7 536097      Helianthus annuus var. texanus
#>                                                  commonNames    nameUsage
#> 1 annual sunflower,sunflower,wild sunflower,common sunflower     accepted
#> 2                                                         NA not accepted
#> 3                                                         NA not accepted
#> 4                                                         NA not accepted
#> 5                                                         NA not accepted
#> 6                                                         NA not accepted
#> 7                                                         NA not accepted
#> $`Helianthus annuus`
#> [1] NA

Scientific names from common names

comm2sci("black bear", db = "itis")
#> $`black bear`
#> [1] "Ursus americanus luteolus"   "Ursus americanus"           
#> [3] "Ursus americanus"            "Ursus americanus americanus"
#> [5] "Chiropotes satanas"          "Ursus thibetanus"           
#> [7] "Ursus thibetanus"

Lowest common rank among taxa

spp <- c("Sus scrofa", "Homo sapiens", "Nycticebus coucang")
lowest_common(spp, db = "ncbi")
#>             name        rank      id
#> 21 Boreoeutheria below-class 1437010

Coerce codes to taxonomic id classes

numeric to uid

as.uid(315567)
#> [1] "315567"
#> attr(,"class")
#> [1] "uid"
#> attr(,"match")
#> [1] "found"
#> attr(,"multiple_matches")
#> [1] FALSE
#> attr(,"pattern_match")
#> [1] FALSE
#> attr(,"uri")
#> [1] "https://www.ncbi.nlm.nih.gov/taxonomy/315567"

list to uid

as.uid(list("315567", "3339", "9696"))
#> [1] "315567" "3339"   "9696"  
#> attr(,"class")
#> [1] "uid"
#> attr(,"match")
#> [1] "found" "found" "found"
#> attr(,"multiple_matches")
#> [1] FALSE FALSE FALSE
#> attr(,"pattern_match")
#> [1] FALSE FALSE FALSE
#> attr(,"uri")
#> [1] "https://www.ncbi.nlm.nih.gov/taxonomy/315567"
#> [2] "https://www.ncbi.nlm.nih.gov/taxonomy/3339"  
#> [3] "https://www.ncbi.nlm.nih.gov/taxonomy/9696"

Coerce taxonomic id classes to a data.frame

out <- as.uid(c(315567, 3339, 9696))
(res <- data.frame(out))
#>      ids class match multiple_matches pattern_match
#> 1 315567   uid found            FALSE         FALSE
#> 2   3339   uid found            FALSE         FALSE
#> 3   9696   uid found            FALSE         FALSE
#>                                            uri
#> 1 https://www.ncbi.nlm.nih.gov/taxonomy/315567
#> 2   https://www.ncbi.nlm.nih.gov/taxonomy/3339
#> 3   https://www.ncbi.nlm.nih.gov/taxonomy/9696

Contributing

See our CONTRIBUTING document.

Contributors

Alphebetical

Code Contributors

All Contributors!

Collected via GitHub Issues - this list honors all contributions, whether code or not.

Alphebetical

afkoeppel - ahhurlbert - albnd - Alectoria - andzandz11 - antagomir - arendsee - ashenkin - ashiklom - bomeara - bw4sz - cboettig - cdeterman - ChrKoenig - chuckrp - clarson2191 - claudenozeres - cmzambranat - daattali - DanielGMead - davharris - davidvilanova - diogoprov - dlebauer - dlenz1 - dschlaep - EDiLD - emhart - fdschneider - fgabriel1891 - fmichonneau - gedankenstuecke - gimoya - GISKid - git-og - glaroc - gustavobio - ibartomeus - jangorecki - jarioksa - jebyrnes - johnbaums - jonmcalder - JoStaerk - jsgosnell - kamapu - karthik - katrinleinweber - KevCaz - kgturner - kmeverson - Koalha - ljvillanueva - Markus2015 - mcsiple - MikkoVihtakari - millerjef - miriamgrace - mpnelsen - MUSEZOOLVERT - nate-d-olson - nmatzke - npch - paternogbc - philippi - pmarchand1 - pssguy - RodgerG - rossmounce - sariya - scelmendorf - sckott - SimonGoring - snsheth - snubian - Squiercg - tdjames1 - tmkurobe - tpaulson1 - tpoisot - vijaybarve - wcornwell - willpearse - wpetry - zachary-foster

Road map

Check out our milestones to see what we plan to get done for each version.

Meta

By participating in this project you agree to abide by its terms.

Copy Link

Version

Install

install.packages('taxize')

Monthly Downloads

8,885

Version

0.9.4

License

MIT + file LICENSE

Issues

60

Pull Requests

0

Stars

266

Forks

59

Maintainer

Scott Chamberlain

Last Published

July 24th, 2018

Functions in taxize (0.9.4)

apg

Get APG names
downstream

Retrieve the downstream taxa for a given taxon name or ID.
comm2sci

Get scientific names from common names.
fungorum

Index Fungorum
eol_invasive

Search for presence of taxonomic names in EOL invasive species databases.
gnr_datasources

Get data sources for the Global Names Resolver.
gnr_resolve

Resolve names using Global Names Resolver.
apg_orders

MOBOT order names
eubon_hierarchy

EUBON hierarchy
itis_taxrank

Retrieve taxonomic rank name from given TSN.
apg_families

MOBOT family names
eol_pages

Search for pages in EOL database using a taxonconceptID.
gbif_parse

Parse taxon names using the GBIF name parser.
eubon_capabilities

EUBON capabilities
eol_search

Search for terms in EOL database.
eubon_children

EUBON children
col_classification

Search Catalogue of Life for taxonomic classifications.
eol_hierarchy

Retrieve the taxonomic hierarchy from given EOL taxonID.
get_eolid

Get the EOL ID from Encyclopedia of Life from taxonomic names.
get_genes

Retrieve gene sequences from NCBI by accession number.
genbank2uid

Get NCBI taxonomy UID from GenBankID
get_gbifid

Get the GBIF backbone taxon ID from taxonomic names.
itis_terms

Get ITIS terms, i.e., tsn's, authors, common names, and scientific names.
get_nbnid

Get the UK National Biodiversity Network ID from taxonomic names.
get_seqs

Retrieve gene sequences from NCBI by accession number.
get_genes_avail

Retrieve gene sequences from NCBI by accession number.
get_tsn

Get the TSN code for a search term.
gbif_downstream

Retrieve all taxa names downstream in hierarchy for GBIF
plantGenusNames

Vector of plant genus names from ThePlantList
gisd_isinvasive

Check invasive species status for a set of species from GISD database
plantNames

Vector of plant species (genus - specific epithet) names from ThePlantList
getkey

Function to get API key.
get_wormsid

Get Worms ID for a taxon name
get_ubioid

Get the uBio id for a search term
rankagg

Aggregate data by given taxonomic rank
resolve

Resolve names from different data sources
gni_details

Search for taxonomic name details using the Global Names Index.
lowest_common

Retrieve the lowest common taxon and rank for a given taxon name or ID
ipni_search

Search for names in the International Plant Names Index (IPNI).
taxize-package

Taxonomic Information from Around the Web
eubon

EUBON taxonomy search
itis_acceptname

Retrieve accepted TSN and name
ion

ION - Index to Organism Names
get_boldid

Get the BOLD (Barcode of Life) code for a search term.
get_colid

Get the Catalogue of Life ID from taxonomic names.
get_iucn

Get a IUCN Redlist taxon
get_natservid

Get NatureServe taxonomic ID for a taxon name
gbif_name_usage

Lookup details for specific names in all taxonomies in GBIF.
iucn_getname

Get any matching IUCN species names
get_tolid

Get the OTT id for a search term
iplant_resolve

iPlant name resolution
key_helpers

Helpers to set up authentication for the different providers.
tp_accnames

Return all accepted names for a taxon name with a given id.
taxize_capwords

Capitalize the first letter of a character string.
itis_name

Get taxonomic names for a given taxonomic name query.
itis_lsid

Get TSN from LSID
tp_acceptednames

Return all accepted names for a taxon name with a given id.
iucn_id

Get an ID for a IUCN listed taxon
names_list

Get a random vector of species names.
limited_print

Print a subset of a character vector
tpl_families

Get The Plant List families.
tpl_get

Get The Plant List csv files.
ncbi_downstream

Retrieve all taxa names downstream in hierarchy for NCBI
get_ids

Retrieve taxonomic identifiers for a given taxon name.
get_id_details

Details on get_*() functions
iucn_status

Extractor functions for iucn-class.
get_uid

Get the UID codes from NCBI for taxonomic names.
sci2comm

Get common names from scientific names.
get_tpsid

Get the NameID codes from Tropicos for taxonomic names.
itis_downstream

Retrieve all taxa names or TSNs downstream in hierarchy from given TSN.
iucn_summary

Get a summary from the IUCN Red List
ncbi_search

Search for gene sequences available for taxa from NCBI.
itis_getrecord

Get full ITIS record for one or more ITIS TSN's or lsid's.
tax_agg

Aggregate species data to given taxonomic rank
phylomatic_format

Get family names to make Phylomatic input object, and output input string to Phylomatic for use in the function phylomatic_tree.
scrapenames

Resolve names using Global Names Recognition and Discovery.
tax_name

Get taxonomic names for a given rank
theplantlist

Lookup-table for family, genus, and species names for ThePlantList
tnrs

Phylotastic Taxonomic Name Resolution Service.
get_wiki

Get the page name for a Wiki taxon
taxize_cite

Get citations and licenses for data sources used in taxize
ubio_classification_search

This function will return ClassificationBankIDs (hierarchiesIDs) that refer to the given NamebankID
ubio_id

Search uBio by namebank ID.
taxize_ldfast

Replacement function for ldply that should be faster in all cases.
gni_parse

Parse scientific names using EOL's name parser.
itis_native

Get jurisdiction data, i.e., native or not native in a region.
gni_search

Search for taxonomic names using the Global Names Index.
itis_refs

Get references related to a ITIS TSN.
itis_hierarchy

ITIS hierarchy
itis_kingdomnames

Get kingdom names
ncbi_get_taxon_summary

NCBI taxon information from uids
plantminer

Search for taxonomy data from Plantminer.com
nbn_synonyms

Return all synonyms for a taxon name with a given id from NBN
ncbi_children

Search NCBI for children of a taxon
nbn_classification

Search UK National Biodiversity Network database for taxonomic classification
tp_dist

Return all distribution records for for a taxon name with a given id.
tp_classification

Return all synonyms for a taxon name with a given id.
nbn_search

Search UK National Biodiversity Network
ncbi_getbyid

Retrieve gene sequences from NCBI by accession number.
phylomatic_tree

Query Phylomatic for a phylogenetic tree.
rank_ref

Lookup-table for IDs of taxonomic ranks
ncbi_getbyname

Retrieve gene sequences from NCBI by taxon name and gene names.
tax_rank

Get rank for a given taxonomic name.
ubio_ping

uBio ping
ubio_search

This function will return NameBankIDs that match given search terms
taxize-defunct

Defunct functions in taxize
tp_summary

Return summary data a taxon name with a given id.
tp_namedistributions

Return all distribution records for for a taxon name with a given id.
tp_synonyms

Return all synonyms for a taxon name with a given id.
ubio_synonyms

Search uBio for taxonomic synonyms by hierarchiesID.
tp_namereferences

Return all reference records for for a taxon name with a given id.
ping

Ping an API used in taxize to see if it's working.
status_codes

Get HTTP status codes
synonyms

Retrieve synonyms from various sources given input taxonomic names or identifiers
upstream

Retrieve the upstream taxa for a given taxon name or ID.
tnrs_sources

TNRS sources
tpl_search

A light wrapper around the taxonstand fxn to call Theplantlist.org database.
tp_refs

Return all reference records for for a taxon name with a given id.
tol_resolve

Resolve names using Open Tree of Life (OTL) resolver
tp_search

Search Tropicos by scientific name, common name, or Tropicos ID.
vascan_search

Search the CANADENSYS Vascan API.
ubio_classification

uBio classification
bold_search

Search Barcode of Life for taxonomic IDs
children

Retrieve immediate children taxa for a given taxon name or ID.
col_children

Search Catalogue of Life for for direct children of a particular taxon.
col_downstream

Use Catalogue of Life to get downstream taxa to a given taxonomic level.
col_search

Search Catalogue of Life for taxonomic IDs
class2tree

Convert a list of classifications to a tree.
classification

Retrieve the taxonomic hierarchy for a given taxon ID.
eol_dataobjects

Given the identifier for a data object, return all metadata about the object
apg_lookup

Lookup in the APGIII taxonomy and replace family names