id.converter: Converting or Updating FlyBase IDs or Symbols

View source: R/id.converter.R

id.converterR Documentation

Converting or Updating FlyBase IDs or Symbols

Description

The function takes FlyBase IDs (e.g. FBgn0000003) or Gene symbols as an input, and converts it into updated IDs or symbols using the FlyBase ID converter (web). The function accesses FlyBase, so requires internet-connection. FlyBase ID inputs are bundled as 1,000. 100 for symbols. FlyBase IDs for genes that are split into multiple genes will be concatenated with two colons (::). Genes that does not have matching IDs will be shown as "unknown". Certain gene symbols would appear as "unknown" even if the gene exists, and have FlyBase IDs. This is because the ID converter in FlyBase website cannot convert the gene. For example, CG31976 cannot be converted by FlyBase, although you can find the gene from the gene report. Setting diehard.symbols = T will look for gene report pages of such unconvertible genes one by one. The process is essentially slow because it accesses FlyBase for each gene.

Usage

id.converter(x, symbols = F, bundle.size = 1000, DmelOnly = T, polite.access = 0, diehard.symbols = F, convert.into)

Arguments

x

a vector. FlyBase IDs or names to be converted.

symbols

Logical. If TRUE, the output will be gene symbols, rather than FlyBase IDs. Default = F

bundle.size

Numeric. The number of FlyBase IDs or symbols to be submitted to FlyBase at once. Default is 1,000 if there are less than 100 symbols; 100 if more than 1,000 symbols. Reduce the number down if Timeout error occurs.

DmelOnly

Logical. If TRUE, non-melanogaster gene IDs will be ignored. Default = T.

polite.access

Numeric. Intervals between FlyBase access for each bundle as seconds. Default = 0.

diehard.symbols

Logical. If TRUE, gene symbols that are not automatically converted by the FlyBase ID converter, will be searched from gene reports to find out the most matching genes. Default = F.

convert.into

"genes", "transcripts", or "polypeptides". "g", "t", or "p" is also possible. If missing, inputs will be updated to the most recent IDs only.

Examples

id.converter(x, symbols = T)
id.converter(x, bundle.size = 50, polite.access = 10, convert.into = "transcripts")
id.converter(x, symbols = T, bundle.size = 50, diehard.symbols = T)

hangnoh/flybaseR documentation built on Feb. 25, 2023, 2:26 p.m.