Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

rba_uniprot_taxonomy_name

Search UniProt Taxonomic Names


Description

Using this function, you can search and retrieve taxonomic nodes using their names from UniProt Taxonomy database.

Usage

rba_uniprot_taxonomy_name(
  name,
  field = "scientific",
  search_type = "equal_to",
  node_only = TRUE,
  page_size = 200,
  page_number = 1,
  ...
)

Arguments

name

a name to to be used as search query.

field

Specify the field that your provided name should be searched. It should be one of : "scientific" (default), "common" or "mnemonic".

search_type

The logical relationship between your provided search query and the taxonomic name field. It should be one of "equal_to" (default), "start_with", "end_with" or "contain".

node_only

(logical) Retrieve only the node(s) information and exclude URL links to parents, siblings and children nodes. default = TRUE

page_size

(numeric) Your search results may be very long, thus UniProt API will paginate the results, you may use this argument to control the pagination. maximum value is 200.

page_number

(numeric) Your search results may be very long, thus UniProt API will paginate the results, you may use this argument to control the pagination. maximum value is 200.

...

rbioapi option(s). Refer to rba_options's arguments documentation for more information on available options.

Value

a list containing taxonomic nodes that match your provided inputs.

Corresponding API Resources

"GET https://ebi.ac.uk/proteins/api/name/name"
"GET https://ebi.ac.uk/proteins/api/name/name/node"

References

  • Andrew Nightingale, Ricardo Antunes, Emanuele Alpi, Borisas Bursteinas, Leonardo Gonzales, Wudong Liu, Jie Luo, Guoying Qi, Edd Turner, Maria Martin, The Proteins API: accessing key integrated protein and genome information, Nucleic Acids Research, Volume 45, Issue W1, 3 July 2017, Pages W539–W544, https://doi.org/10.1093/nar/gkx237

  • Proteins API Documentation

See Also

Examples

rba_uniprot_taxonomy_name(name = "homo", field = "scientific",
    search_type = "start_with")


rba_uniprot_taxonomy_name(name = "adenovirus", field = "scientific",
    search_type = "contain", page_size = 200, page_number = 2)

rbioapi

User-Friendly R Interface to Biologic Web Services' API

v0.7.0
GPL-3
Authors
Moosa Rezwani [aut, cre, cph]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.