rbioapi: rba_uniprot_uniparc – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

rba_uniprot_uniparc

Get UniParc entry

Description

Use this function to retrieve UniParc entries. You can use either -and only one of- UniProt accession, Cross-reference database id, UniParc ID or UniProt Proteome UPID. You can also filter the returned content of the returned UniParc entry. see "Argument" section for more details.

Usage

rba_uniprot_uniparc(
  upi = NA,
  accession = NA,
  db_id = NA,
  upid = NA,
  rf_dd_type = NA,
  rf_db_id = NA,
  rf_active = NA,
  rf_tax_id = NA,
  ...
)

Arguments

`upi`	unique UniParc Identifier.
`accession`	UniProtKB primary or secondary accession.
`db_id`	Protein ID in the cross-reference (external) database.
`upid`	UniProt Proteome identifier (UPID). You can provide up to 100 UPIDs.
`rf_dd_type`	Filter the content of the UniParc entry by cross-reference names. You can provide multiple values.
`rf_db_id`	Filter the content of the UniParc entry by protein identifiers in any cross-reference database. You can provide multiple values.
`rf_active`	(logical ) Filter the content of UniParc entry based on active status on source database: NA: don't filter contents based on active status. TRUE: only return contents which are still active. FALSE: Only return contents which are not active.
`rf_tax_id`	(Numeric) Filter the content of the UniParc entry by NIH-NCBI Taxon ID. You can provide multiple values.
`...`	rbioapi option(s). Refer to `rba_options`'s arguments documentation for more information on available options.

Value

A list which correspond to a UniParc entry.

Corresponding API Resources

"GET https://ebi.ac.uk/proteins/api/uniparc/accession/accession "
"GET https://ebi.ac.uk/proteins/api/uniparc/dbreference/dbid"
"GET https://ebi.ac.uk/proteins/api/uniparc/proteome/upid"
"GET https://ebi.ac.uk/proteins/api/uniparc/upi/upi"

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

Examples

rba_uniprot_uniparc(upi = "UPI00000000C9")


rba_uniprot_uniparc(upi = "UPI00000000C9")


rba_uniprot_uniparc(upi = "UPI00000000C9", rf_active = FALSE)

rbioapi

User-Friendly R Interface to Biologic Web Services' API

v0.7.0

GPL-3

Authors

Moosa Rezwani [aut, cre, cph]

Initial release