Nothing
#' Concentric layout
#'
#' @description
#' The "concentric" layout places the nodes on one or more circles,
#' with each group of nodes on a circle of its own,
#' and the groups ordered around those circles
#' so that adjacent nodes are drawn close together.
#' Where one group holds a single node, that node occupies the centre.
#' @name layout_concentric
#' @template param_ggraphlayouts
#' @param membership A node attribute or a vector to draw concentric circles.
#' By default this is the two modes of a two-mode network.
#' @param radius A vector of radii at which the concentric circles
#' should be located.
#' By default this is equal placement around an empty centre,
#' unless one (the core) is a single node,
#' in which case this node occupies the centre of the graph.
#' @param order.by An attribute label indicating the (decreasing) order
#' for the nodes around the circles.
#' By default ordering is given by a bipartite placement that reduces
#' the number of edge crossings.
#' @family mapping
#' @source
#' Diego Diez, Andrew P. Hutchins and Diego Miranda-Saavedra. 2014.
#' "Systematic identification of transcriptional regulatory modules from
#' protein-protein interaction networks".
#' _Nucleic Acids Research_, 42 (1) e6.
#' @examples
#' #graphr(ison_southern_women, layout = "concentric", membership = "type",
#' # node_color = "type", node_size = 3)
#' @export
layout_concentric <- function(.data, membership, radius = NULL,
order.by = NULL,
circular = FALSE, times = 1000) {
.data <- manynet::as_igraph(.data)
# An unlabelled network is given the names `manynet::node_names()` invents
# for it, so that the groups, the ordering and the coordinates all name a
# node the same way. Without this the groups are named while
# `manynet::is_labelled()` says they are not, and the two disagree: every
# node falls out of its own group and is drawn on a circle of its own.
# Only the coordinates are returned, so the invented names go no further.
if (!manynet::is_labelled(.data))
.data <- igraph::set_vertex_attr(.data, "name",
value = manynet::node_names(.data))
if (any(igraph::vertex_attr(.data, "name") == "")) {
ll <- unlist(lapply(seq_len(length(.data)), function(x) {
ifelse(igraph::vertex_attr(.data, "name")[x] == "",
paste0("ramdom", x), igraph::vertex_attr(.data, "name")[x])
}))
.data <- igraph::set_vertex_attr(.data, "name", value = ll)
}
if (missing(membership)) {
if (manynet::is_twomode(.data)) membership <- manynet::node_is_mode(.data) else
.abort_layout_arg("membership", "concentric", length(.data))
} else {
if (length(membership) > 1 & length(membership) != length(.data)) {
.abort_layout_arg("membership", "concentric", length(.data))
} else if (length(membership) != length(.data)) {
membership <- .match_name(membership, igraph::vertex_attr_names(.data),
"membership", what = "node attribute")
membership <- manynet::node_attribute(.data, membership)
}
}
names(membership) <- manynet::node_names(.data)
membership <- .to_list(membership)
all_c <- unlist(membership, use.names = FALSE)
if (any(table(all_c) > 1)) {
duplicated_nodes <- names(which(table(all_c) > 1))
manynet::snet_abort(
"The {.val concentric} layout draws each node in one circle only,",
"but {.val {duplicated_nodes}} appear{?s} in more than one.",
"Please check that {.arg membership} gives each node a single group.")
}
if (manynet::is_labelled(.data)) all_n <- manynet::node_names(.data) else
all_n <- 1:manynet::net_nodes(.data)
sel_other <- all_n[!all_n %in% all_c]
if (length(sel_other) > 0) membership[[length(membership) + 1]] <- sel_other
if (is.null(radius)) {
radius <- seq(0, 1, 1/(length(membership)))
if (length(membership[[1]]) == 1)
radius <- radius[-length(radius)] else radius <- radius[-1]
}
if (!is.null(order.by)) {
order.by <- .match_name(order.by, igraph::vertex_attr_names(.data),
"order.by", what = "node attribute")
values <- manynet::node_attribute(.data, order.by)
names(values) <- manynet::node_names(.data)
# `order.by` orders the nodes within each circle, not the circles
# themselves, so the circles are still taken smallest first, as they are
# by default. This keeps `radius` meaning the same either way.
order.values <- lapply(membership[order(sapply(membership, length))],
function(g) g[order(values[g], decreasing = TRUE)])
} else {
if (manynet::is_twomode(.data) & length(membership) == 2) {
# `to_onemode()` squares both modes into one matrix with every 'manynet'
# version. `to_multilevel()` no longer does: it leaves a 'stocnet'
# two-mode, and since 'manynet' 2.4.0 it keeps 'type' on an igraph, so
# that `as_matrix()` returns the incidence matrix instead.
xnet <- manynet::as_matrix(manynet::to_onemode(.data))[membership[[2-1]],
membership[[2]]]
lo <- layout_tbl_graph_layered(manynet::as_igraph(xnet, twomode = TRUE))
lo$names <- manynet::node_names(.data)
if (ncol(lo) == 2) lo[,1] <- seq_len(dim(lo)[1])
order.values <- lapply(1:0, function(x)
if(ncol(lo) >= 3) sort(lo[lo[,2] == x,])[,3]
else sort(lo[lo[,2] == x,1]))
} else order.values <- membership[order(sapply(membership, length))]
}
res <- matrix(NA, nrow = length(all_n), ncol = 2)
for (k in seq_along(membership)) {
r <- radius[k]
l <- order.values[[k]]
if(manynet::is_labelled(.data))
l <- match(l, manynet::node_names(.data))
res[l, ] <- .get_coordinates(l, r)
}
.to_lo(res)
}
#' @rdname layout_concentric
#' @export
layout_tbl_graph_concentric <- layout_concentric
# Helper functions --------------------------------------------------------
# Turn a vector of memberships into a list of the nodes in each group.
# A node whose membership is NA belongs to no group: `sort()` drops NA, so
# such a node reaches none of the groups, and `layout_concentric()` gathers
# whatever is left over onto a circle of its own. The groups are named from
# the same values they are built from, which also keeps each name on its own
# group where the values do not arrive in sorted order.
.to_list <- function(members) {
groups <- sort(unique(members))
out <- lapply(groups, function(x){
y <- which(members==x)
if(!is.null(names(y))) names(y) else y
})
names(out) <- groups
out
}
# Space the nodes `x` evenly around a circle of radius `r`.
.get_coordinates <- function(x, r) {
l <- length(x)
d <- 360/l
c1 <- seq(0, 360, d)
c1 <- c1[1:(length(c1) - 1)]
tmp <- t(vapply(c1,
function(cc) c(cos(cc * pi/180) *
r, sin(cc *
pi/180) * r),
FUN.VALUE = numeric(2)))
rownames(tmp) <- x
tmp
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.