plotLinkCommSumm: Plot a Summary of the Link Community Algorithm Output

Description Usage Arguments Details Value Author(s) References See Also Examples

View source: R/linkcomm_plotting.R

Description

This function is called by plot.linkcomm to plot a summary of the output of the linkcomm algorithm.

Usage

1
2
plotLinkCommSumm(x, col = TRUE, pal = brewer.pal(9, "Set1"), right = TRUE, 
                 droptrivial = TRUE, verbose = TRUE, ...)

Arguments

x

An object of class linkcomm.

col

Logical, whether to colour link communities in the dendrogram. Defaults to TRUE.

pal

A character vector describing a colour palette to be used for colouring the link community dendrogram. Defaults to brewer.pal(9, "Set1").

right

Logical, whether to orient the dendrogram to the right. Defaults to TRUE.

droptrivial

Logical, whether to not colour communities of size 2. Defaults to TRUE.

...

Additional arguments to be passed to plot.

verbose

Logical, whether to display the progress of colouring the dendrogram on the screen. Defaults to TRUE.

Details

Here we describe the parameters for plotting link community summaries using:
plot(x, type = "summary")

Value

A summary plot of the output from the linkcomm algorithm.

Author(s)

Alex T. Kalinka alex.t.kalinka@gmail.com

References

Kalinka, A.T. and Tomancak, P. (2011). linkcomm: an R package for the generation, visualization, and analysis of link communities in networks of arbitrary size and type. Bioinformatics 27, 2011-2012.

See Also

plot.linkcomm

Examples

1
2
3
4
5
6
## Generate graph and extract link communities.
g <- swiss[,3:4]
lc <- getLinkCommunities(g)

## Plot the modularity of the link communities.
plot(lc, type = "summary")

alextkalinka/linkcomm documentation built on Feb. 11, 2021, 4:53 a.m.