vivainsights.network_summary

Summarize node centrality statistics from an igraph network object.

vivainsights.network_summary.network_summary(graph, hrvar=None, return_type='table')

Summarise node centrality statistics from an igraph object.

Parameters:

• graph (igraph.Graph) – Graph object returned from network_g2g() or network_p2p() with return_type="network".

• hrvar (str, optional) – HR variable by which to split metrics. Defaults to None.

• return_type (str) –

  Type of output to return. Valid values:

  • "table" (default): summary DataFrame.

  • "network": igraph object with centrality attributes added.

  • "plot": (not yet implemented).

Returns:

DataFrame with columns betweenness, closeness, degree, eigenvector, and pagerank; or the enriched igraph object.

Return type:

pandas.DataFrame or igraph.Graph

Examples

Return centrality metrics as a table:

>>> import vivainsights as vi
>>> graph = vi.network_g2g(data=vi.load_g2g_data(), return_type="network")
>>> vi.network_summary(graph, hrvar="Organization", return_type="table")

Return the enriched igraph network object:

>>> vi.network_summary(graph, hrvar="Organization", return_type="network")