globalOverlayClustering.multiplex: Global overlay clustering coefficient of the multiplex...

Description Usage Arguments Details Value References See Also Examples

Description

This function calculates De Domenico et al.'s global overlay clustering coefficient.

Usage

1
2
3
4
globalOverlayClustering.multiplex(obj,
                                  indexLayer = 1:length(layers.multiplex(obj)),
                                  verbose = FALSE
                                  )

Arguments

obj

An object of class multiplex.

indexLayer

A vector of IDs (or labels) for the selected (intra)layers on which to calculate the global overlay clustering coefficient.

verbose

Default is FALSE. If TRUE, it prints on console the value of the standardizing coefficient of the index.

Details

It is defined as a kind of generalization of C1 global clustering coefficient and C2 global clustering coefficient, and it's simply obtained as the local clustering coefficient of the overlay monoplex network of the multiplex network obtained with aggregated.overlapping.multiplex function. The index has a standardization that allows comparisons with other multiplex network: the standardizing factor can be obtained with the verbose argument.

Value

A number, the global overlay clustering coefficient.

References

De Domenico et al (2014). Mathematical formulation of multilayer networks. Phys. Rev. X 3, 041022.

See Also

create.multiplex

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Loading Aarhus CS Department dataset.

data(aarhus_mplex)

# Creating the multiplex object using the dataset loaded into aarhus_mplex object.

mplexObj <- create.multiplex(nodes = aarhus_mplex$nodes,
                            layersNames = aarhus_mplex$layerNames,
                            layer1 = aarhus_mplex$L1,
                            type1 = "undirected",
                            aarhus_mplex$L2,
                            aarhus_mplex$L3,
                            aarhus_mplex$L4,
                            aarhus_mplex$L5
                            )

# Calculating the global overlay clustering coefficient of the multiplex network:

globalOverlayClustering.multiplex(mplexObj)

# Selecting the layers on which to calculate the coefficient, using 'indexLayer' argument:

globalOverlayClustering.multiplex(mplexObj, indexLayer = c(1, 2))

# It could be useful to visualize the standardizing coefficient applied to the denominator
# of the index, mostly if the relationships are weighted and not binary like in this example.
# Using the 'verbose = TRUE' argument, it is printed on console:

globalOverlayClustering.multiplex(mplexObj, verbose = TRUE)

Achab94/mplex documentation built on May 5, 2019, 11:46 a.m.