calculate_basic_statistics: Calculate basic network statistics for a network and print to...

View source: R/RWR_netstats.R

calculate_basic_statisticsR Documentation

Calculate basic network statistics for a network and print to screen.

Description

Calculate basic network statistics for a network and print to screen.

Usage

calculate_basic_statistics(
  g,
  name = NULL,
  directed = FALSE,
  unconnected = TRUE,
  weights = NULL,
  verbose = FALSE
)

Arguments

g

An igraph object.

name

A name for the network (optional).

directed

Logical, whether directed or undirected paths are to be considered. This is ignored for undirected graphs.

unconnected

Logical, what to do if the graph is unconnected. If FALSE, the function will return a number that is one larger the largest possible diameter, which is always the number of vertices. If TRUE, the diameters of the connected components will be calculated and the largest one will be returned.

weights

Optional positive weight vector for calculating weighted distances. If the graph has a weight edge attribute, then this is used by default.

verbose

Print progress to console.

See Also

igraph::vcount, igraph::ecount, igraph::diameter.


dkainer/RWRtoolkit documentation built on Jan. 11, 2025, 3:26 a.m.