generate_mappings: The 'boilerplate' for this package's desired graph style

Description Usage Arguments Value Examples

View source: R/generate_mappings.R

Description

Generates an object that can be converted to a JSON file and subsequently applied to the graph for the markup specified by this package and the layout mirroring KEGG. Intended for use within cyto_vis

Usage

1
2
generate_mappings(style_name, map_edge_width, edge_width_attribute,
  min_score, max_score)

Arguments

style_name

An argument to name style; when used inside of cyto_vis no name is needed

map_edge_width

A logical indicator; if FALSE no continuous mapping of edge width will be applied

edge_width_attribute

The attribute that will be used for edge width; if data is not added or the attribute is not part of the graphing information, the edge width will default to 1.

min_score

The minimum attribute value for the column used to map edge width

max_score

The maximum attribute value for the column used to map edge width

Value

A list that can be converted to a JSON file to apply desired style/layout in Cytoscape

Examples

1
2
style.name = "myKEGGstyle"
mappings <- generate_mappings(style.name, FALSE)

KEGGlincs documentation built on Nov. 8, 2020, 5:47 p.m.