propcal: Edge frequency in the SE-set

View source: R/propcal.R

propcalR Documentation

Edge frequency in the SE-set

Description

A function used to analyse the SEset results. Calculates the proportion of path models in a given SEset in which a particular edge is present

Usage

propcal(SEmatrix, names = NULL, rm_duplicate = TRUE, directed = TRUE)

Arguments

SEmatrix

An n \times p matrix containing the SEset, where each row represents a p \times p weights matrix stacked column-wise

names

optional character vector containing dimension names

rm_duplicate

Should duplicate weights matrices be removed from the SEset. Defaults to TRUE.

directed

If FALSE, the directionality of edges is ignored, and the output reflects in what proportion of the SEset an edge of any direction is present. If TRUE, the proportion is calculated seperately for edges of either direction. Defaults to TRUE

Value

a p \times p matrix showing in what proportion particular edges are present. If directed=TRUE, elements ij denote the proportion of weights matrices containing a path from X_j to X_i. If directed=F, the output will be a symmetric matrix, with element ij denoting in what proprtion an edge of either direction connects X_i to X_j.

References

\insertRef

ryan2019SEset

See Also

network_to_SEset


SEset documentation built on March 18, 2022, 5:51 p.m.