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

In frankkramer-lab/rBiopaxParser: Parses BioPax files and represents them in 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

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

 # 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")

frankkramer-lab/rBiopaxParser documentation built on July 19, 2020, 9:49 a.m.