to_parameters: Format ipath data.frame as parameters

Description Usage Arguments Value Author(s)

View source: R/format_data.R

Description

Format ipath data.frame as parameters

Usage

1
2
3
4
to_parameters(ipath_data, default_color = "#bdbdbd", default_width = 3,
  default_radius = 7, default_opacity = 1, keep_colors = FALSE,
  whole_modules = FALSE, whole_pathways = FALSE,
  query_reactions = FALSE, tax_filter = "", export_dpi = 1200)

Arguments

ipath_data

data.frame formatted for sending to ipath

default_color

Hex color value. Non-selected parts of the map will use this color by default.

default_width

Default path/edge width (px) for the non-selected parts of the map.

default_radius

Compound radius (px) for the non-selected parts of the map.

default_opacity

Opacity setting for the non-selected parts of the map. Zero represents full transparency, while one is fully opaque.

keep_colors

Keep original colors? When TRUE, non-selected parts of the map will not change color to the default one.

whole_modules

Select whole modules? When TRUE, any KEGG module with at least one matching edge or compound will be highlighted.

whole_pathways

Select whole pathways? If TRUE, any pathway with at least one matching edge or compound will be highlighted.

query_reactions

Query reaction compounds. If TRUE, compound presence within each edges reactions will also be checked

tax_filter

string containing either NCBI tax ID or KEGG 3 letter species code(s). Only pathways present in selected species will be included in the map.

export_dpi

numeric value for DPI of SVG output.

Value

list of parameters for ipath

Author(s)

Beth Signal


betsig/ipath documentation built on March 12, 2021, 12:06 a.m.