mapVisualProperty: Creates a mapping between an attribute and a visual property

Description Usage Arguments Details Value List of visual properties See Also Examples

View source: R/mapVisualProperty.R

Description

Generates the appropriate data structure for the "mapping" parameter in setStyleMappings and createStyle.

Usage

1
2
3
mapVisualProperty(visual.prop, table.column, mapping.type, table.column.values,
  visual.prop.values, network = "current",
  base.url = "http://localhost:1234/v1")

Arguments

visual.prop

(char) name of visual property to map

table.column

(char) name of table column to map

mapping.type

(char) continuous, discrete or passthrough (c,d,p)

table.column.values

(list) list of values paired with visual.prop.values; skip for passthrough mapping

visual.prop.values

(list) list of values paired with table.column.values; skip for passthrough mapping

network

name or suid of the network; default is "current" network

base.url

cyrest base url for communicating with cytoscape

Details

The paired list of values must be of the same length or mapping will fail. Mapping will also fail if the data type of table.column.values does not match that of the existing table.column. Note that all imported numeric data are stored as Doubles in Cytosacpe tables; and character or mixed data are stored as Strings.

Value

(obj) ready to convert into JSON by style mapping operations

List of visual properties

Node Border Line Type Edge Bend Network Background Paint
Node Border Paint Edge Curved Network Center X Location
Node Border Transparency Edge Label Network Center Y Location
Node Border Width Edge Label Color Network Center Z Location
Node CustomGraphics 1-9 Edge Label Font Face Network Depth
Node CustomGraphics Position 1-9 Edge Label Font Size Network Edge Selection
Node CustomGraphics Size 1-9 Edge Label Transparency Network Height
Node CustomPaint 1-9 Edge Label Width Network Node Selection
Node Depth Edge Line Type Network Scale Factor
Node Fill Color Edge Paint Network Size
Node Height Edge Selected Network Title
Node Label Edge Selected Paint Network Width
Node Label Color Edge Source Arrow Selected Paint
Node Label Font Face Edge Source Arrow Shape
Node Label Font Size Edge Source Arrow Size
Node Label Position Edge Source Arrow Unselected Paint
Node Label Transparency Edge Stroke Selected Paint
Node Label Width Edge Stroke Unselected Paint
Node Network Image Visible Edge Target Arrow Selected Paint
Node Paint Edge Target Arrow Shape
Node Selected Edge Target Arrow Size
Node Selected Paint Edge Target Arrow Unselected Paint
Node Shape Edge Tooltip
Node Size Edge Transparency
Node Tooltip Edge Unselected Paint
Node Transparency Edge Visible
Node Visible Edge Visual Property
Node Width Edge Width
Node X Location
Node Y Location
Node Z Location

See Also

setStyleMappings createStyle

Examples

1
2
3
mapVisualProperty('node fill color','score','c',c(-4.0,0.0,9.0),c('#99CCFF','#FFFFFF','#FF7777'))
mapVisualProperty('node shape','type','d',c('protein','metabolite'),c('ellipse','rectangle'))
mapVisualProperty('node label','alias','p')

cytoscape/r2cytoscape documentation built on May 4, 2019, 6:36 p.m.