Skip to content

data_types

network_data

type_name network_data The registered name for this item type.
documentation

Data that can be assembled into a graph.

This data type extends the 'tables' type from the kiara_plugin.tabular plugin, restricting the allowed tables to one called 'edges', and one called 'nodes'.

Edges

The 'edges' table contains the following columns:

_edge_id:

The unique id for the edge.

_source:

The node id of the source for an edge.

_target:

The node id of the target for an edge.

_count_dup_directed:

The number of edges that have the same source/target combination as this (incl. this), if the network_data is interpreted as directed multi graph.

_idx_dup_directed:

A unique index for this edge within its set of duplicates, if the network_data is interpreted as directed multi graph.

This is a unique integer identifier in combination with (_source/_target), counting up from 1. The order of the edges within this set is not guaranteed.

_count_dup_undirected:

The number of edges that have the same source/target combination as this (incl. this), if the network_data is interpreted as undirected multi graph.

_idx_dup_undirected:

A unique index for this edge within its set of duplicates, if the network_data is interpreted as undirected multi graph.

This is a unique integer identifier in combination with (_source/_target), counting up from 1. The order of the edges within this set is not guaranteed.

Nodes

The 'nodes' table contains the following columns:

_node_id:

The unique id for the node.

This is a unique integer identifier (counting up from 0) and is automatically generated by kiara, for each network_data value.

_label:

The label for the node.

This is a (potentially non-unique) (ideally) human meaningful lable for the node, mostly used in visualizations. Depending on how the 'network_data' was created, this could be a name, title, etc. If no such label was available or specified by the user, the node id will be used as label.

_count_edges:

The number of edges that are connected to this node if the network_data is interpreted as a non-multi graph

Both incoming and outgoing edges are counted, which means that the number is valid for both directed and undirected graphs. .

_count_edges_multi:

The number of edges that are connected to this node if the network_data is interpreted as a multi graph

Both incoming and outgoing edges are counted, which means that the number is valid for both directed and undirected graphs.

_in_edges:

The number of incoming edges that are connected to this node if the network_data is interpreted as a non-multi graph.

_in_edges_multi:

The number of incoming edges that are connected to this node if the network_data is interpreted as a multi graph.

_out_edges:

The number of outgoing edges that are connected to this node if the network_data is interpreted as a non-multi graph.

_out_edges_multi:

The number of outgoing edges that are connected to this node if the network_data is interpreted as a multi graph.

Documentation for the item.
authors Information about authorship for the item.
context
tags network_analysis
labels
  • package: kiara_plugin.network_analysis
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name NetworkDataType The name of the Python class.
python_module_name kiara_plugin.network_analysis.data_types The name of the Python module this class lives in.
full_name kiara_plugin.network_analysis.data_types.NetworkDataType The full class namespace.
The python class that implements this module type.
value_cls
python_class_name NetworkData The name of the Python class.
python_module_name kiara_plugin.network_analysis.models The name of the Python module this class lives in.
full_name kiara_plugin.network_analysis.models.NetworkData The full class namespace.
The python class of the value itself.
data_type_config_cls
python_class_name DataTypeConfig The name of the Python class.
python_module_name kiara.data_types The name of the Python module this class lives in.
full_name kiara.data_types.DataTypeConfig The full class namespace.
The python class holding the schema for configuring this type.
lineage
  • network_data
  • tables
  • any
This types lineage.
qualifier_profiles
A map of qualifier profiles for this data types.
supported_properties
group_title Metadata models for type 'network_data' The group alias.
item_infos
network_graph_properties
type_name network_data The registered name for this item type.
documentation

Network data stats.

Documentation for the item.
authors Information about authorship for the item.
context
tags network_analysis
labels
  • package: kiara_plugin.network_analysis
references
Generic properties of this item (description, tags, labels, references, ...).
python_class
python_class_name NetworkGraphProperties The name of the Python class.
python_module_name kiara_plugin.network_analysis.models The name of the Python module this class lives in.
full_name kiara_plugin.network_analysis.models.NetworkGraphProperties The full class namespace.
The python class that implements this module type.
metadata_schema
$defs
ComponentProperties
description Properties of a connected component.
properties
component_id
description The id of the component.
title Component Id
type integer
number_of_nodes
description The number of nodes in the component.
title Number Of Nodes
type integer
number_of_associated_edge_rows
description The number of edge rows associated to the component.
title Number Of Associated Edge Rows
type integer
required
  • component_id
  • number_of_nodes
  • number_of_associated_edge_rows
title ComponentProperties
type object
GraphProperties
description Properties of graph data, if interpreted as a specific graph type.
properties
number_of_edges
description The number of edges.
title Number Of Edges
type integer
parallel_edges
default 0
description The number of parallel edges (if 'multi' graph type).
title Parallel Edges
type integer
required
  • number_of_edges
title GraphProperties
type object
additionalProperties False
description Network data stats.
properties
number_of_nodes
description Number of nodes in the network graph.
title Number Of Nodes
type integer
properties_by_graph_type
additionalProperties
$ref #/$defs/GraphProperties
description Properties of the network data, by graph type.
propertyNames
enum
  • directed
  • undirected
  • undirected_multi
  • directed_multi
title Properties By Graph Type
type object
number_of_self_loops
description Number of edges where source and target point to the same node.
title Number Of Self Loops
type integer
number_of_components
description Number of connected components in the network graph.
title Number Of Components
type integer
components
additionalProperties
$ref #/$defs/ComponentProperties
description Properties of the components of the network graph.
title Components
type object
required
  • number_of_nodes
  • properties_by_graph_type
  • number_of_self_loops
  • number_of_components
  • components
title NetworkGraphProperties
type object
The (json) schema for this metadata value.
The value metadata info instances for each type.
type_name value_metadata
The supported property types for this data type.