RCy3 (version 1.2.0)

getLayoutNameMapping: getLayoutNameMapping

Description

The Cytoscape 'Layout' menu lists many layout algorithms, but the names presented there are different from the names by which these algorithms are known to layout method. This method returns a named list in which the names are from the GUI, and the values identify the names you must use to choose an algorithms in the programmatic interface.

Usage

getLayoutNameMapping(obj)

Arguments

obj

a CytoscapeConnectionClass object.

Value

A named list of strings.

See Also

getLayoutNames getLayoutPropertyNames getLayoutPropertyType getLayoutPropertyValue setLayoutProperties

Examples

  # first, delete existing windows to save memory:
  deleteAllWindows(CytoscapeConnection())

  cy <- CytoscapeConnection ()
  layout.name.map <- getLayoutNameMapping (cy)
  print (head (names (layout.name.map), n=3))
    # [1] "Attribute Circle Layout"     "Stacked Node Layout"        
    # [3] "Degree Sorted Circle Layout"
  print (head (as.character (layout.name.map), n=3))
    # [1] "attribute-circle"    "stacked-node-layout" "degree-circle"