met.reach: Reach centrality

View source: R/met.reach.R

met.reachR Documentation

Reach centrality

Description

Calculates the weighted node metric 'reach centrality' for all vertices.

Usage

met.reach(M, df = NULL, dfid = NULL)

Arguments

M

a square adjacency matrix, or a list of square adjacency matrices, or an output of ANT functions stat.ds.grp, stat.df.focal, stat.net.lk.

df

a data frame of same length as the input matrix or a list of data frames if argument M is a list of matrices or an output of ANT functions stat.ds.grp, stat.df.focal, stat.net.lk.

dfid

an integer or a string indicating the column with individual ids in argument df.

Details

Reach is the sum of the product of ego's and alters' strengths and alters' degrees.

Value

  • An integer vector of nodes reach centrality if argument df is NULL.

  • A list of integer vectors of nodes reach centrality if argument M is a list of matrices and if argument df is NULL.

  • A list of arguments df with a new column for nodes reach centrality titled 'reach centrality', if argument df is not NULL.

  • A list of arguments df with a new column for nodes reach centrality if 1) argument df is not NULL, 2) argument M is an output from ANT functions stat.ds.grp, stat.df.focal, stat.net.lk for multiple matrices permutations, and 3) argument df is a list of data frames of same length as argument M. The name of the column of each element of the list is adapted according to argument value binary.

Author(s)

Sebastian Sosa, Ivan Puga-Gonzalez.

References

Whitehead, H. A. L. (1997). Analysing animal social structure. Animal behaviour, 53(5), 1053-1067.

Examples

met.reach(sim.m)
head(sim.df)
met.reach(sim.m,df=sim.df)

SebastianSosa/ANTs documentation built on Sept. 25, 2023, 11:06 p.m.