> ## Documentation Index
> Fetch the complete documentation index at: https://docs.graphext.com/llms.txt
> Use this file to discover all available pages before exploring further.

# extract_node_betweenness

> Calculate network node betweenness. 

Calculates the [betweenness centrality](https://en.wikipedia.org/wiki/Betweenness_centrality)
for each node in the network. Betweenness centrality is a measure of the number of times a node acts
as a bridge along the shortest path between two other nodes.

## Usage

The following example shows how the step can be used in a recipe.

<Accordion title="Examples" icon="code" defaultOpen="true">
  <Tabs>
    <Tab title="Example 1">
      ```stan theme={null}
      extract_node_betweenness(ds.targets, ds.weights) -> (ds.betweenness)
      ```
    </Tab>

    <Tab title="Signature">
      General syntax for using the step in a recipe. Shows the inputs and outputs the step is expected to receive and will produce respectively. For futher details see sections below.

      ```stan theme={null}
      extract_node_betweenness(targets: list[number], *weights: list[number], {
          "param": value,
          ...
      }) -> (betweenness: number)
      ```
    </Tab>
  </Tabs>
</Accordion>

## Inputs & Outputs

The following are the inputs expected by the step and the outputs it produces. These are generally
columns (`ds.first_name`), datasets (`ds` or `ds[["first_name", "last_name"]]`) or models (referenced
by name e.g. `"churn-clf"`).

<Accordion title="Inputs" icon="right-to-bracket">
  <ParamField path="targets" type="column[list[number]]" required>
    A column containing link targets. Source is implied in the index.
  </ParamField>

  <ParamField path="*weights" type="column[list[number]]">
    An optional column containing link weights.
  </ParamField>
</Accordion>

<Accordion title="Outputs" icon="right-from-bracket">
  <ParamField path="betweenness" type="column[number]" required>
    A column containing the betweenness metric for each node/row.
  </ParamField>
</Accordion>

## Configuration

The following parameters can be used to configure the behaviour of the step by including them in
a json object as the last "input" to the step, i.e. `step(..., {"param": "value", ...}) -> (output)`.

<Accordion title="Parameters" defaultOpen="true" icon="sliders">
  <ParamField path="directed" type="boolean" default="false">
    Whether the links are directed or not.
  </ParamField>

  <ParamField path="cutoff" type="[number, null]">
    The maximum path length to consider when calculating the betweenness.
    If cutoff is zero or negative then there is no such limit.
  </ParamField>
</Accordion>