Skip to content

Extract node closeness

network

Calculcate network node closeness.

Usage


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

Step signature
extract_node_closeness(
    targets: list[number],
    *weights: list[number], 
    {
        "param": value
    }
) -> (closeness: 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.

Example

Example call (in recipe editor)
extract_node_closeness(ds.targets, ds.weights) -> (ds.closeness)

Inputs


targets: column:list[number]

A column containing link targets. Source is implied in the index.


*weights: column:list[number]

Outputs


closeness: column:number

Column containing how many steps is required to access every other vertex from a given vertex.

Parameters


  • If cutoff is zero or negative then there is no such limit.
  • Mode defines the types of the paths used for measuring the distance in directed graphs. “in” measures the paths to a vertex, “out” measures paths from a vertex, all uses undirected paths. This argument is ignored for undirected graphs.

mode: string = "all"

Which node connections to count.

Must be one of: "all", "out", "in", "both"

Example parameter values:

  • "all"
  • "out"
  • "in"
  • "both"

normalized: boolean = True

Whether to calculate the normalized closeness.

Example parameter values:

  • false
  • true

cutoff: number | null

The maximum path length to consider when calculating the betweenness.

Example parameter values:

  • 2
Back to top