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

rba_reactome_analysis_download

Download Different Reactome Analysis Results

Description

Based on the "request" argument, you can download different analysis results data associated with a given token.

Usage

rba_reactome_analysis_download(
  token,
  request,
  save_to = NA,
  resource = "TOTAL",
  ...
)

Arguments

token

A token associated to your previous Reactome analysis.
request

What to download? Should be one of:

  • "found_ids": Download a CSV file containing the found user-provided identifiers in the analysis associated with your provided token and resource.

  • "not_found_ids"" Download a CSV file containing the user-provided Identifiers which has not been found in the analysis associated with your provided token.

  • "pathways": Download a CSV file containing Pathway analysis results of the analysis associated with your provided token and resource.

  • "results": Download a JSON file containing the complete analysis results associated with your provided token.

  • "results_gz" Same as "results", but the output will be compress (gzipped).
save_to

NA or Character:

  • NA: Save the file to an automatically-generated path.

  • Character string: A valid file path to save the file to.
resource

(Only when request is "found_ids" or "pathways") Filter results based on the resource. Default is "TOTAL", available choices are:"TOTAL", "UNIPROT", "ENSEMBL", "CHEBI", "IUPHAR", "MIRBASE", "NCBI_PROTEIN", "EMBL", "COMPOUND", "ENTITIES_FDR" or "PUBCHEM_COMPOUND".
...

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

Details

Token is associated to each Reactome analysis results and kept by Reactome for at least 7 days. You can locate it in rba_reactome_analysis's output, under a sub-list named "summary" (i.e. results$summary$token).
Use rba_reactome_analysis_pdf to save a full report in PDF format.

Value

NULL, a CSV,JSON or Gzipped JSON file will be saved to disk based on your input.

Corresponding API Resources

GET https://reactome.org/AnalysisService/download/token/entities/ found/resource/filename.csv" GET https://reactome.org/AnalysisService//download/token/entities/ notfound/filename.csv" GET https://reactome.org/AnalysisService/download/token/pathways/ resource/filename.csv" GET https://reactome.org/AnalysisService/download/token/result.json" GET https://reactome.org/AnalysisService/download/token/result.json.gz"

References

  • Fabregat A, Sidiropoulos K, Viteri G, Forner O, Marin-Garcia P, Arnau V, D'Eustachio P, Stein L, Hermjakob H. Reactome pathway analysis: a high-performance in-memory approach. BMC bioinformatics. 2017 Mar;18(1) 142. doi: 10.1186/s12859-017-1559-2. PubMed PMID: 28249561. PubMed Central PMCID: PMC5333408.

  • Reactome Analysis Services API Documentation

See Also

Examples

## Not run: 
rba_reactome_analysis_download(token = "MjAyMDEwMTYwMTI3MTNfMjY1MjM",
    request = "found_ids", save_to = "found_ids.csv")

## End(Not run)
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.