Skip to content

operations

assemble.network_data

Documentation

Create a 'network_data' instance from one or two tables.

This module needs at least one table as input, providing the edges of the resulting network data set. If no further table is created, basic node information will be automatically created by using unique values from the edges source and target columns.

If no source_column_name (and/or target_column_name) is provided, kiara will try to auto-detect the most likely of the existing columns to use. If that is not possible, an error will be raised.

Inputs
field name type description required default
edges table A table that contains the edges data. yes
source_column string The name of the source column name in the edges table. no
target_column string The name of the target column name in the edges table. no
edges_column_map dict An optional map of original column name to desired. no
nodes table A table that contains the nodes data. no
id_column string The name (before any potential column mapping) of the node-table column that contains the node identifier (used in the edges table). no
label_column string The name of a column that contains the node label (before any potential column name mapping). If not specified, the value of the id value will be used as label. no
nodes_column_map dict An optional map of original column name to desired. no
Outputs
field name type description required default
network_data network_data The network/graph data. yes

create.network_data.from.file

Documentation

Create a table from a file, trying to auto-determine the format of said file.

Supported file formats (at the moment):

  • gml
  • gexf
  • graphml (uses the standard xml library present in Python, which is insecure - see xml for additional information. Only parse GraphML files you trust)
  • pajek
  • leda
  • graph6
  • sparse6
Inputs
field name type description required default
file file The source value (of type 'file'). yes
Outputs
field name type description required default
network_data network_data The result value (of type 'network_data'). yes

network_data_filter.select_component

Documentation

-- n/a --

Inputs
field name type description required default
value network_data A value of type 'network_data'. yes
component_id integer The id of the componen to select. no 0
Outputs
field name type description required default
value network_data The filtered value. yes