sbgnNodes: Extract glyph information

In datapplab/SBGNview: "SBGNview: Data Analysis, Integration and Visualization on SBGN Pathways"

Extract glyph information

Description

This function will extract node information such as complex members, compartment members, node class, nodes with state variables etc.

Usage

sbgnNodes(
  input.sbgn,
  output.gene.id.type = NA,
  output.cpd.id.type = NA,
  database = NA,
  species = NA,
  show.ids.for.multiHit = NULL,
  SBGNview.data.folder = "./SBGNview.tmp.data",
  sbgn.dir = "./"
)

Arguments

input.sbgn	A character string. required. The pathway ID of pre-collected pathways or a path to a local SBGN-ML file.
output.gene.id.type	A character string. The desired output gene ID type. It only works when the SBGN-ML file is from one of these databases: 'MetaCyc' and 'pathwayCommons'. Currently, only 'macromolecule' glyphs are supported. Please check data('mapped.ids') for the types accepted. If omitted, the output IDs are the oritinal IDs in the SBGN-ML file.
output.cpd.id.type	A character string. The desired output compound ID type. It only works when the SBGN-ML file is from one of these databases: 'MetaCyc' and 'pathwayCommons'. Currently, only 'simple chemical' glyphs are supported. Please check data('mapped.ids') for the types accepted. If omitted, the output IDs are the oritinal IDs in the SBGN-ML file.
database	A character string. If the SBGN-ML file is from one of these databases: 'MetaCyc' and 'pathwayCommons', this parameter should be set to the corresponding string. For these two databases, this function can output other ID types instead of the original IDs in the SBGN-ML files. Otherwise, the output IDs are the oritinal IDs in the 'id' attribure in the 'glyph' element.
species	A character string. Only output IDs from this particular species. It only works when the SBGN-ML file is from one of these databases: 'MetaCyc' and 'pathwayCommons'. Please check data('supported.species') for supported species. If omitted, the function will output IDs from all species.
show.ids.for.multiHit	Vector. When there are multiple output IDs mapped to a glyph, we only show the ones in this vector.
SBGNview.data.folder	A character string. Default: "./SBGNview.tmp.data". The path to a folder that will hold downloaded ID mapping files and pathway information data files.
sbgn.dir	A character string. Default: "./". The path to a folder that will hold created SBGN-ML files, if the input.sbgn are IDs of pre-collected pathways.

Details

The following glyph information is extracted: complex members, compartment members,submap members, node class, nodes with state variables, class of state variables, edges with cardinality, nodes with ports, 'source and sink' nodes, process nodes.
When trying to output other ID types, sometimes multiple output IDs are mapped to one glyph. In this situation, the IDs are concatenated by '; ' to represent the glyph.

Value

A list containing extracted glyph information.

Examples

data(mapped.ids)
data(sbgn.xmls)
data(pathways.info)
node.list <- sbgnNodes(input.sbgn = 'P00001',
                       output.gene.id.type = 'ENTREZID',
                       output.cpd.id.type = 'compound.name',
                       species = 'hsa')

datapplab/SBGNview documentation built on June 20, 2022, 9:55 p.m.