Skip to content

Extract node betweenness

network

Calculate network node betweenness.

Example

extract_node_betweenness(links) -> (ds.betweenness)

Usage

The following are the step's expected inputs and outputs and their specific types.

extract_node_betweenness(links: dataset, {"param": value}) -> (betweenness: number)

where the object {"param": value} is optional in most cases and if present may contain any of the parameters described in the corresponding section below.

Inputs


links: dataset

A dataset of links between nodes, i.e. containing source, target and weight columns.

Outputs


betweenness: column:number

Column containing the number of shortest paths going through a vertex.

Parameters


directed: boolean = False

Whether the links are directed or not.


cutoff: number | null

The maximum path length to consider when calculating the betweenness. If cutoff is zero or negative then there is no such limit.


weights: string | null

Optional column name containing positive weights for calculating weighted betweenness. If the graph has a weight edge attribute, then this is used by default. Weights are used to calculate weighted shortest paths, so they are interpreted as distances.