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

rba_reactome_exporter_overview

Get a Reactome Pathway Overview

Description

This function will Save a Pathway Overview of the provided specie as an image file.

Usage

rba_reactome_exporter_overview(
  species,
  output_format = "png",
  save_to = NA,
  image_quality = 5,
  flag_element = NA,
  flg_interactors = TRUE,
  sel = NA,
  title = TRUE,
  margin = 15,
  diagram_profile = "Copper",
  token = NA,
  resource = "TOTAL",
  exp_column = NA,
  coverage = FALSE,
  ...
)

Arguments

species

Numeric or Character: NCBI Taxonomy identifier (Human Taxonomy ID is 9606.) or species name (e.g. "Homo sapiens"). Refer to rba_reactome_species or Reactome Data Schema: Entries: Species.
output_format

Images format, Can be one of: png (default), jpeg, svg or gif.
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.
image_quality

Numeric: A number ranging from 1 to 10. 1 is the lowest quality and 10 is the highest (default = 5).
flag_element

Gene name, protein ID, chemical ID or Reactome ID of a diagram's element to be flagged.
flg_interactors

Logical: Should the interactor be considered when flagging a diagram element? (default = TRUE)
sel

CSV line for highlighting element(s) selection in the diagram.
title

Logical: Should the pathway name be displayed below the image? (default = TRUE)
margin

Numeric: A number ranging from 0 to 20 to set as the image's margin. (default = 15)
diagram_profile

Color profile of diagrams, should be one of "Copper" (default), "Copper Plus", "Barium Lithium" or "calcium salts".
token

The analysis Token for which the results will be overlaid on top of the given pathways overview. see: rba_reactome_analysis.
resource

The analysis resource for which the results will be overlaid on top of the given pathways overview.
exp_column

numeric: (only if token is provided) Specify the expression column for the overlay.
coverage

Logical: Should the analysis coverage values be overlaid? (default = FALSE)
...

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

Value

NULL, Based to the inputs, an image file will be saved to disk.

Corresponding API Resources

"GET https://reactome.org/ContentService/exporter/fireworks/species.ext"

References

  • Jassal B, Matthews L, Viteri G, Gong C, Lorente P, Fabregat A, Sidiropoulos K, Cook J, Gillespie M, Haw R, Loney F, May B, Milacic M, Rothfels K, Sevilla C, Shamovsky V, Shorser S, Varusai T, Weiser J, Wu G, Stein L, Hermjakob H, D'Eustachio P. The reactome pathway knowledgebase. Nucleic Acids Res. 2020 Jan 8;48(D1):D498-D503. doi: 10.1093/nar/gkz1031. PubMed PMID: 31691815.

  • Reactome Content Services API Documentation

See Also

Other "Reactome Content Service - Format Exporter": rba_reactome_exporter_diagram(), rba_reactome_exporter_event(), rba_reactome_exporter_reaction()

Examples

## Not run: 
rba_reactome_exporter_overview(species = 9606,
    output_format = "svg",
    save_to = "human_pathways.svg")

## End(Not run)
## Not run: 
rba_reactome_exporter_overview(species = 9606,
    token = 123456789)

## 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.