getInstanceProperty: This function returns all properties of the specified type...

Description Usage Arguments Value Author(s) Examples

View source: R/selectBiopax.R

Description

This function returns all properties of the specified type for an instance. By default this function returns the NAME property of an instance.

Usage

1
2
3
4
5
6
7
getInstanceProperty(
  biopax,
  id,
  property = "NAME",
  includeAllNames = TRUE,
  biopaxlevel = 3
)

Arguments

biopax

A biopax model

id

string

property

string.

includeAllNames

logical. Biopax Level 3 brought 2 new name properties: displayName and standardName. Per default this return all names of an instance. Disable if you only want the NAME property.

biopaxlevel

integer. Set the biopax level here if you supply a data.table directly.

Value

Returns a character vector with all properties of the selected type for this instance. Returns NULL if no property data is found.

Author(s)

fkramer

Examples

1
2
3
4
5
 # load data
 data(biopaxexample)
 getInstanceProperty(biopax, id="ex_m_100650", property="NAME")
 getInstanceProperty(biopax, id="ex_m_100650", property="ORGANISM")
 getInstanceProperty(biopax, id="ex_m_100650", property="COMPONENTS")

rBiopaxParser documentation built on Nov. 8, 2020, 8:21 p.m.