Retrieve all genes

get_genes(
  genes,
  raw = getOption("gemma.raw", FALSE),
  memoised = getOption("gemma.memoised", FALSE),
  file = getOption("gemma.file", NA_character_),
  overwrite = getOption("gemma.overwrite", FALSE)
)

Arguments

genes

A vector of NCBI IDs, Ensembl IDs or gene symbols.

raw

TRUE to receive results as-is from Gemma, or FALSE to enable parsing. Raw results usually contain additional fields and flags that are omitted in the parsed results.

memoised

Whether or not to save to cache for future calls with the same inputs and use the result saved in cache if a result is already saved. Doing options(gemma.memoised = TRUE) will ensure that the cache is always used. Use forget_gemma_memoised to clear the cache.

file

The name of a file to save the results to, or NULL to not write results to a file. If raw == TRUE, the output will be the raw endpoint from the API, likely a JSON or a gzip file. Otherwise, it will be a RDS file.

overwrite

Whether or not to overwrite if a file exists at the specified filename.

Value

A data table with information about the querried gene(s) A list if raw = TRUE.

The fields of the output data.table are:

  • gene.symbol: Symbol for the gene

  • gene.ensembl: Ensembl ID for the gene

  • gene.NCBI: NCBI id for the gene

  • gene.name: Name of the gene

  • gene.aliases: Gene aliases. Each row includes a vector

  • gene.MFX.rank: Multifunctionality rank for the gene

  • taxon.name: Name of the species

  • taxon.scientific: Scientific name for the taxon

  • taxon.ID: Internal identifier given to the species by Gemma

  • taxon.NCBI: NCBI ID of the taxon

  • taxon.database.name: Underlying database used in Gemma for the taxon

  • taxon.database.ID: ID of the underlying database used in Gemma for the taxon

Examples

get_genes("DYRK1A")
#>    gene.symbol       gene.ensembl gene.NCBI
#>         <char>             <char>     <int>
#> 1:      DYRK1A    ENSG00000157540      1859
#> 2:      Dyrk1a ENSMUSG00000022897     13548
#> 3:      Dyrk1a ENSRNOG00000001662     25255
#>                                                        gene.name
#>                                                           <char>
#> 1: dual specificity tyrosine phosphorylation regulated kinase 1A
#> 2: dual-specificity tyrosine phosphorylation regulated kinase 1a
#> 3: dual specificity tyrosine phosphorylation regulated kinase 1A
#>                                                      gene.aliases gene.MFX.rank
#>                                                            <list>         <num>
#> 1:                                  DYRK,DYRK1,HP86,MNB,MNBH,MRD7     0.9658868
#> 2: 2310043O08Rik,D16Ertd272e,D16Ertd493e,Dyrk,Gm10783,Mnbh,...[8]     0.9685388
#> 3:                                                     Dyrk,PSK47     0.9535178
#>    taxon.name  taxon.scientific taxon.ID taxon.NCBI taxon.database.name
#>        <char>            <char>    <int>      <int>              <char>
#> 1:      human      Homo sapiens        1       9606                hg38
#> 2:      mouse      Mus musculus        2      10090                mm10
#> 3:        rat Rattus norvegicus        3      10116                 rn6
#>    taxon.database.ID
#>                <int>
#> 1:                87
#> 2:                81
#> 3:                86
get_genes(c("DYRK1A", "PTEN"))
#>    gene.symbol       gene.ensembl gene.NCBI
#>         <char>             <char>     <int>
#> 1:      DYRK1A    ENSG00000157540      1859
#> 2:        PTEN    ENSG00000171862      5728
#> 3:      Dyrk1a ENSMUSG00000022897     13548
#> 4:        Pten ENSMUSG00000013663     19211
#> 5:      Dyrk1a ENSRNOG00000001662     25255
#> 6:        Pten ENSRNOG00000020723     50557
#>                                                        gene.name
#>                                                           <char>
#> 1: dual specificity tyrosine phosphorylation regulated kinase 1A
#> 2:                                phosphatase and tensin homolog
#> 3: dual-specificity tyrosine phosphorylation regulated kinase 1a
#> 4:                                phosphatase and tensin homolog
#> 5: dual specificity tyrosine phosphorylation regulated kinase 1A
#> 6:                                phosphatase and tensin homolog
#>                                                      gene.aliases gene.MFX.rank
#>                                                            <list>         <num>
#> 1:                                  DYRK,DYRK1,HP86,MNB,MNBH,MRD7     0.9658868
#> 2:                        10q23del,BZS,CWS1,DEC,GLM2,MHAM,...[10]     0.9971606
#> 3: 2310043O08Rik,D16Ertd272e,D16Ertd493e,Dyrk,Gm10783,Mnbh,...[8]     0.9685388
#> 4:  2310035O07Rik,A130070J02Rik,B430203M17Rik,MMAC1,PTENbeta,TEP1     0.9992364
#> 5:                                                     Dyrk,PSK47     0.9535178
#> 6:                                                MMAC1,Mmac,TEP1     0.9982868
#>    taxon.name  taxon.scientific taxon.ID taxon.NCBI taxon.database.name
#>        <char>            <char>    <int>      <int>              <char>
#> 1:      human      Homo sapiens        1       9606                hg38
#> 2:      human      Homo sapiens        1       9606                hg38
#> 3:      mouse      Mus musculus        2      10090                mm10
#> 4:      mouse      Mus musculus        2      10090                mm10
#> 5:        rat Rattus norvegicus        3      10116                 rn6
#> 6:        rat Rattus norvegicus        3      10116                 rn6
#>    taxon.database.ID
#>                <int>
#> 1:                87
#> 2:                87
#> 3:                81
#> 4:                81
#> 5:                86
#> 6:                86