nplot: Plot a network

In netplot: Beautiful Graph Drawing

Plot a network

Description

This is a description.

Usage

nplot(
  x,
  layout,
  vertex.size = 1,
  bg.col = "transparent",
  vertex.nsides = 10,
  vertex.color = grDevices::hcl.colors(1),
  vertex.size.range = c(0.01, 0.03, 4),
  vertex.frame.color = NULL,
  vertex.rot = 0,
  vertex.frame.prop = 0.2,
  vertex.label = NULL,
  vertex.label.fontsize = NULL,
  vertex.label.color = adjustcolor("black", alpha.f = 0.8),
  vertex.label.fontfamily = "sans",
  vertex.label.fontface = "plain",
  vertex.label.show = 0.3,
  vertex.label.range = c(5, 15),
  edge.width = 1,
  edge.width.range = c(1, 2),
  edge.arrow.size = NULL,
  edge.color = ~ego(alpha = 0.1, col = "gray") + alter,
  edge.curvature = pi/3,
  edge.line.lty = "solid",
  edge.line.breaks = 5,
  sample.edges = 1,
  skip.vertex = FALSE,
  skip.edges = FALSE,
  skip.arrows = skip.edges,
  add = FALSE,
  zero.margins = TRUE,
  edgelist
)

## S3 method for class 'igraph'
nplot(
  x,
  layout = igraph::layout_nicely(x),
  vertex.size = igraph::degree(x, mode = "in"),
  bg.col = "transparent",
  vertex.nsides = 10,
  vertex.color = grDevices::hcl.colors(1),
  vertex.size.range = c(0.01, 0.03, 4),
  vertex.frame.color = NULL,
  vertex.rot = 0,
  vertex.frame.prop = 0.2,
  vertex.label = igraph::vertex_attr(x, "name"),
  vertex.label.fontsize = NULL,
  vertex.label.color = adjustcolor("black", alpha.f = 0.8),
  vertex.label.fontfamily = "sans",
  vertex.label.fontface = "plain",
  vertex.label.show = 0.3,
  vertex.label.range = c(5, 15),
  edge.width = igraph::edge_attr(x, "weight"),
  edge.width.range = c(1, 2),
  edge.arrow.size = NULL,
  edge.color = ~ego(alpha = 0.1, col = "gray") + alter,
  edge.curvature = pi/3,
  edge.line.lty = "solid",
  edge.line.breaks = 5,
  sample.edges = 1,
  skip.vertex = FALSE,
  skip.edges = FALSE,
  skip.arrows = !igraph::is_directed(x),
  add = FALSE,
  zero.margins = TRUE,
  edgelist
)

## S3 method for class 'network'
nplot(
  x,
  layout = sna::gplot.layout.kamadakawai(x, NULL),
  vertex.size = sna::degree(x, cmode = "indegree"),
  bg.col = "transparent",
  vertex.nsides = 10,
  vertex.color = grDevices::hcl.colors(1),
  vertex.size.range = c(0.01, 0.03, 4),
  vertex.frame.color = NULL,
  vertex.rot = 0,
  vertex.frame.prop = 0.2,
  vertex.label = network::get.vertex.attribute(x, "vertex.names"),
  vertex.label.fontsize = NULL,
  vertex.label.color = adjustcolor("black", alpha.f = 0.8),
  vertex.label.fontfamily = "sans",
  vertex.label.fontface = "plain",
  vertex.label.show = 0.3,
  vertex.label.range = c(5, 15),
  edge.width = 1,
  edge.width.range = c(1, 2),
  edge.arrow.size = NULL,
  edge.color = ~ego(alpha = 0.1, col = "gray") + alter,
  edge.curvature = pi/3,
  edge.line.lty = "solid",
  edge.line.breaks = 5,
  sample.edges = 1,
  skip.vertex = FALSE,
  skip.edges = FALSE,
  skip.arrows = !network::is.directed(x),
  add = FALSE,
  zero.margins = TRUE,
  edgelist
)

## S3 method for class 'matrix'
nplot(
  x,
  layout,
  vertex.size = 1,
  bg.col = "transparent",
  vertex.nsides = 10,
  vertex.color = grDevices::hcl.colors(1),
  vertex.size.range = c(0.01, 0.03, 4),
  vertex.frame.color = NULL,
  vertex.rot = 0,
  vertex.frame.prop = 0.2,
  vertex.label = NULL,
  vertex.label.fontsize = NULL,
  vertex.label.color = adjustcolor("black", alpha.f = 0.8),
  vertex.label.fontfamily = "sans",
  vertex.label.fontface = "plain",
  vertex.label.show = 0.3,
  vertex.label.range = c(5, 15),
  edge.width = 1,
  edge.width.range = c(1, 2),
  edge.arrow.size = NULL,
  edge.color = ~ego(alpha = 0.1, col = "gray") + alter,
  edge.curvature = pi/3,
  edge.line.lty = "solid",
  edge.line.breaks = 5,
  sample.edges = 1,
  skip.vertex = FALSE,
  skip.edges = FALSE,
  skip.arrows = skip.edges,
  add = FALSE,
  zero.margins = TRUE,
  edgelist
)

## Default S3 method:
nplot(
  x,
  layout,
  vertex.size = 1,
  bg.col = "transparent",
  vertex.nsides = 10,
  vertex.color = grDevices::hcl.colors(1),
  vertex.size.range = c(0.01, 0.03, 4),
  vertex.frame.color = NULL,
  vertex.rot = 0,
  vertex.frame.prop = 0.2,
  vertex.label = NULL,
  vertex.label.fontsize = NULL,
  vertex.label.color = adjustcolor("black", alpha.f = 0.8),
  vertex.label.fontfamily = "sans",
  vertex.label.fontface = "plain",
  vertex.label.show = 0.3,
  vertex.label.range = c(5, 15),
  edge.width = 1,
  edge.width.range = c(1, 2),
  edge.arrow.size = NULL,
  edge.color = ~ego(alpha = 0.1, col = "gray") + alter,
  edge.curvature = pi/3,
  edge.line.lty = "solid",
  edge.line.breaks = 5,
  sample.edges = 1,
  skip.vertex = FALSE,
  skip.edges = FALSE,
  skip.arrows = skip.edges,
  add = FALSE,
  zero.margins = TRUE,
  ...,
  edgelist
)

## S3 method for class 'netplot'
print(x, y = NULL, newpage = TRUE, legend = TRUE, ...)

Arguments

x	A graph. It supports networks stored as igraph, network, and matrices objects (see details).
layout	Numeric two-column matrix with the graph layout in x/y positions of the vertices.
vertex.size	Numeric vector of length vcount(x). Absolute size of the vertex from 0 to 1.
bg.col	Color of the background.
vertex.nsides	Numeric vector of length vcount(x). Number of sizes of the vertex. E.g. three is a triangle, and 100 approximates a circle.
vertex.color	Vector of length vcount(x). Vertex HEX or built in colors.
vertex.size.range	Numeric vector of length 3. Relative size for the minimum and maximum of the plot, and curvature of the scale. The third number is used as size^rel[3].
vertex.frame.color	Vector of length vcount(x). Border of vertex in HEX or built in colors.
vertex.rot	Vector of length vcount(x) in Radians. Passed to npolygon, elevation degree from which the polygon is drawn.
vertex.frame.prop	Vector of length vcount(x). What proportion of the vertex does the frame occupy (values between 0 and 1).
vertex.label	Character vector of length vcount(x). Labels.
vertex.label.fontsize	Numeric vector.
vertex.label.color	Vector of colors of length vcount(x).
vertex.label.fontfamily	Character vector of length vcount(x).
vertex.label.fontface	See grid::gpar
vertex.label.show	Numeric scalar. Proportion of labels to show as the top ranking according to vertex.size.
vertex.label.range	Numeric vector of size 2 or 3. Relative scale of vertex.label.fontsize in points (see grid::gpar).
edge.width	Vector of length ecount(x) from 0 to 1. All edges will be the same size.
edge.width.range	Vector of length ecount(x) from 0 to 1. Adjusting width according to weight.
edge.arrow.size	Vector of length ecount(x) from 0 to 1.
edge.color	A vector of length ecount(x). In HEX or built in colors. Can be NULL in which case the color is picked as a mixture between ego and alters' vertex.color values.
edge.curvature	Numeric vector of length ecount(x). Curvature of edges in terms of radians.
edge.line.lty	Vector of length ecount(x). Line types in R (e.g.- 1 = Solid, 2 = Dashed, etc).
edge.line.breaks	Vector of length ecount(x). Number of vertices to draw (approximate) the arc (edge).
sample.edges	Numeric scalar between 0 and 1. Proportion of edges to sample.
skip.vertex, skip.edges, skip.arrows	Logical scalar. When TRUE the object is not plotted.
add	Logical scalar.
zero.margins	Logical scalar.
edgelist	An edgelist.
y, ...	Ignored
newpage	Logical scalar. When TRUE calls grid::grid.newpage.
legend	Logical scalar. When TRUE it adds a legend.

Details

When x is of class matrix, it will be passed to igraph::graph_from_adjacency_matrix().

In the case of edge.color, the user can specify colors using netplot-formulae.

Value

An object of class c("netplot", "gTree", "grob", "gDesc"). The object has an additional set of attributes:

• ⁠.xlim, .ylim⁠ vector of size two with the x-asis/y-axis limits.

• .layout A numeric matrix of size vcount(x) * 2 with the vertices positions

• .edgelist A numeric matrix, The edgelist.

In the case of nplot.default, an object of class netplot and grob (see grid::grob) with the following slots:

• children The main grob of the object.

• name Character scalar. The name of the plot

• .xlim and .ylim Two vectors indicating the limits of the plot

• .layout A two-column matrix with the location of the vertices.

• .edgelist A two-column matrix, an edgelist.

• .N Integer. The number of vertices.

• .M Integer. The number of edges.

The children grob contains the following two objects:

• background a grob rectangule.

• graph a gTree that contains each vertex and each edge of the figure.

See Also

nplot_base

Examples

library(igraph)
library(netplot)
set.seed(1)
x <- sample_smallworld(1, 200, 5, 0.03)

plot(x) # ala igraph
nplot(x) # ala netplot

netplot documentation built on July 1, 2024, 1:06 a.m.