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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016
|
## ----------------------------------------------------------------
##
## IGraph R package
## Copyright (C) 2003-2014 Gabor Csardi <csardi.gabor@gmail.com>
## 334 Harvard street, Cambridge, MA 02139 USA
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
## 02110-1301 USA
##
## ----------------------------------------------------------------
## ----------------------------------------------------------------
## This is the new layout API
## ----------------------------------------------------------------
#' Graph layouts
#'
#' This is a generic function to apply a layout function to
#' a graph.
#'
#' There are two ways to calculate graph layouts in igraph.
#' The first way is to call a layout function (they all have
#' prefix \code{layout_} on a graph, to get the vertex coordinates.
#'
#' The second way (new in igraph 0.8.0), has two steps, and it
#' is more flexible. First you call a layout specification
#' function (the one without the \code{layout_} prefix, and
#' then \code{layout_} (or \code{\link{add_layout_}}) to
#' perform the layouting.
#'
#' The second way is preferred, as it is more flexible. It allows
#' operations before and after the layouting. E.g. using the
#' \code{component_wise} argument, the layout can be calculated
#' separately for each component, and then merged to get the
#' final results.
#'
#' @aliases layout
#' @section Modifiers:
#' Modifiers modify how a layout calculation is performed.
#' Currently implemented modifyers: \itemize{
#' \item \code{component_wise} calculates the layout separately
#' for each component of the graph, and then merges
#' them.
#' \item \code{normalize} scales the layout to a square.
#' }
#'
#' @param graph The input graph.
#' @param layout The layout specification. It must be a call
#' to a layout specification function.
#' @param ... Further modifiers, see a complete list below.
#' For the \code{print} methods, it is ignored.
#' @return The return value of the layout function, usually a
#' two column matrix. For 3D layouts a three column matrix.
#'
#' @seealso \code{\link{add_layout_}} to add the layout to the
#' graph as an attribute.
#' @export
#' @family graph layouts
#' @examples
#' g <- make_ring(10) + make_full_graph(5)
#' coords <- layout_(g, as_star())
#' plot(g, layout = coords)
layout_ <- function(graph, layout, ...) {
modifiers <- list(...)
stopifnot(all(sapply(modifiers, inherits,
what = "igraph_layout_modifier")))
ids <- sapply(modifiers, "[[", "id")
stopifnot(all(ids %in% c("component_wise", "normalize")))
if (anyDuplicated(ids)) stop("Duplicate modifiers")
names(modifiers) <- ids
## TODO: better, generic mechanism for modifiers
if ("component_wise" %in% ids) {
graph$id <- seq(vcount(graph))
comps <- decompose(graph)
coords <- lapply(comps, function(comp) {
do_call(layout$fun, list(graph = comp), layout$args)
})
all_coords <- merge_coords(
comps,
coords,
method = modifiers[["component_wise"]]$args$merge_method
)
all_coords[ unlist(sapply(comps, vertex_attr, "id")), ] <- all_coords[]
result <- all_coords
} else {
result <- do_call(layout$fun, list(graph = graph), layout$args)
}
if ("normalize" %in% ids) {
result <- do_call(norm_coords, list(result),
modifiers[["normalize"]]$args)
}
result
}
#' Add layout to graph
#'
#' @param graph The input graph.
#' @param ... Additional arguments are passed to \code{\link{layout_}}.
#' @param overwrite Whether to overwrite the layout of the graph,
#' if it already has one.
#' @return The input graph, with the layout added.
#'
#' @seealso \code{\link{layout_}} for a description of the layout API.
#' @export
#' @family graph layouts
#' @examples
#' (make_star(11) + make_star(11)) %>%
#' add_layout_(as_star(), component_wise()) %>%
#' plot()
add_layout_ <- function(graph, ..., overwrite = TRUE) {
if (overwrite && 'layout' %in% graph_attr_names(graph)) {
graph <- delete_graph_attr(graph, 'layout')
}
graph$layout <- layout_(graph, ...)
graph
}
layout_spec <- function(fun, ...) {
my_call <- match.call(sys.function(1), sys.call(1))
my_call[[1]] <- substitute(fun)
structure(
list(
fun = fun,
call_str = sub("(", "(<graph>, ", deparse(my_call), fixed = TRUE),
args = list(...)
),
class = "igraph_layout_spec"
)
}
#' @rdname layout_
#' @param x The layout specification
#' @method print igraph_layout_spec
#' @export
print.igraph_layout_spec <- function(x, ...) {
cat(paste(
sep = "",
"igraph layout specification, see ?layout_:\n",
x$call_str, "\n"
))
}
layout_modifier <- function(...) {
structure(
list(...),
class = "igraph_layout_modifier"
)
}
#' @rdname layout_
#' @method print igraph_layout_modifier
#' @export
print.igraph_layout_modifier <- function(x, ...) {
cat(sep = "", "igraph layout modifier: ", x$id, ".\n")
}
#' Component-wise layout
#'
#' This is a layout modifier function, and it can be used
#' to calculate the layout separately for each component
#' of the graph.
#'
#' @param merge_method Merging algorithm, the \code{method}
#' argument of \code{\link{merge_coords}}.
#'
#' @family layout modifiers
#' @family graph layouts
#' @seealso \code{\link{merge_coords}}, \code{\link{layout_}}.
#' @export
#' @examples
#' g <- make_ring(10) + make_ring(10)
#' g %>%
#' add_layout_(in_circle(), component_wise()) %>%
#' plot()
component_wise <- function(merge_method = "dla") {
args <- grab_args()
layout_modifier(
id = "component_wise",
args = args
)
}
#' Normalize layout
#'
#' Scale coordinates of a layout.
#'
#' @param xmin,xmax Minimum and maximum for x coordinates.
#' @param ymin,ymax Minimum and maximum for y coordinates.
#' @param zmin,zmax Minimum and maximum for z coordinates.
#'
#' @family layout modifiers
#' @family graph layouts
#' @seealso \code{\link{merge_coords}}, \code{\link{layout_}}.
#' @export
#' @examples
#' layout_(make_ring(10), with_fr(), normalize())
normalize <- function(xmin = -1, xmax = 1, ymin = xmin, ymax = xmax,
zmin = xmin, zmax = xmax) {
args <- grab_args()
layout_modifier(
id = "normalize",
args = args
)
}
## ----------------------------------------------------------------
## Layout definitions for the new API
## ----------------------------------------------------------------
#' Simple two-row layout for bipartite graphs
#'
#' Minimize edge-crossings in a simple two-row (or column) layout for bipartite
#' graphs.
#'
#' The layout is created by first placing the vertices in two rows, according
#' to their types. Then the positions within the rows are optimized to minimize
#' edge crossings, using the Sugiyama algorithm (see
#' \code{\link{layout_with_sugiyama}}).
#'
#' @aliases layout_as_bipartite layout.bipartite
#' @param graph The bipartite input graph. It should have a logical
#' \sQuote{\code{type}} vertex attribute, or the \code{types} argument must be
#' given.
#' @param types A logical vector, the vertex types. If this argument is
#' \code{NULL} (the default), then the \sQuote{\code{type}} vertex attribute is
#' used.
#' @param hgap Real scalar, the minimum horizontal gap between vertices in the
#' same layer.
#' @param vgap Real scalar, the distance between the two layers.
#' @param maxiter Integer scalar, the maximum number of iterations in the
#' crossing minimization stage. 100 is a reasonable default; if you feel that
#' you have too many edge crossings, increase this.
#' @return A matrix with two columns and as many rows as the number of vertices
#' in the input graph.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @seealso \code{\link{layout_with_sugiyama}}
#' @keywords graphs
#' @export
#' @family graph layouts
#' @examples
#' # Random bipartite graph
#' inc <- matrix(sample(0:1, 50, replace = TRUE, prob=c(2,1)), 10, 5)
#' g <- graph_from_incidence_matrix(inc)
#' plot(g, layout = layout_as_bipartite,
#' vertex.color=c("green","cyan")[V(g)$type+1])
#'
#' # Two columns
#' g %>%
#' add_layout_(as_bipartite()) %>%
#' plot()
layout_as_bipartite <- function(graph, types = NULL, hgap = 1, vgap = 1,
maxiter = 100) {
## Argument checks
if (!is_igraph(graph)) { stop("Not a graph object") }
if (is.null(types) && "type" %in% vertex_attr_names(graph)) {
types <- V(graph)$type
}
if (!is.null(types)) {
if (!is.logical(types)) {
warning("vertex types converted to logical")
}
types <- as.logical(types)
if (any(is.na(types))) {
stop("`NA' is not allowed in vertex types")
}
} else {
stop("Not a bipartite graph, supply `types' argument")
}
hgap <- as.numeric(hgap)
vgap <- as.numeric(vgap)
maxiter <- as.integer(maxiter)
on.exit(.Call(C_R_igraph_finalizer) )
## Function call
res <- .Call(C_R_igraph_layout_bipartite, graph, types, hgap, vgap, maxiter)
res
}
#' @rdname layout_as_bipartite
#' @param ... Arguments to pass to \code{layout_as_bipartite}.
#' @export
as_bipartite <- function(...) layout_spec(layout_as_bipartite, ...)
## ----------------------------------------------------------------
#' Generate coordinates to place the vertices of a graph in a star-shape
#'
#' A simple layout generator, that places one vertex in the center of a circle
#' and the rest of the vertices equidistantly on the perimeter.
#'
#' It is possible to choose the vertex that will be in the center, and the
#' order of the vertices can be also given.
#'
#' @aliases layout_as_star layout.star
#' @param graph The graph to layout.
#' @param center The id of the vertex to put in the center. By default it is
#' the first vertex.
#' @param order Numeric vector, the order of the vertices along the perimeter.
#' The default ordering is given by the vertex ids.
#' @return A matrix with two columns and as many rows as the number of vertices
#' in the input graph.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @seealso \code{\link{layout}} and \code{\link{layout.drl}} for other layout
#' algorithms, \code{\link{plot.igraph}} and \code{\link{tkplot}} on how to
#' plot graphs and \code{\link{star}} on how to create ring graphs.
#' @keywords graphs
#' @export
#' @family graph layouts
#' @examples
#'
#' g <- make_star(10)
#' layout_as_star(g)
#'
#' ## Alternative form
#' layout_(g, as_star())
layout_as_star <- function(graph, center=V(graph)[1], order=NULL) {
# Argument checks
if (!is_igraph(graph)) { stop("Not a graph object") }
center <- as.igraph.vs(graph, center)
if (!is.null(order)) order <- as.numeric(order)-1
on.exit(.Call(C_R_igraph_finalizer) )
# Function call
res <- .Call(C_R_igraph_layout_star, graph, center-1, order)
res
}
#' @rdname layout_as_star
#' @param ... Arguments to pass to \code{layout_as_star}.
#' @export
as_star <- function(...) layout_spec(layout_as_star, ...)
## ----------------------------------------------------------------
#' The Reingold-Tilford graph layout algorithm
#'
#' A tree-like layout, it is perfect for trees, acceptable for graphs with not
#' too many cycles.
#'
#' Arranges the nodes in a tree where the given node is used as the root. The
#' tree is directed downwards and the parents are centered above its children.
#' For the exact algorithm, the refernce below.
#'
#' If the given graph is not a tree, a breadth-first search is executed first
#' to obtain a possible spanning tree.
#'
#' @param graph The input graph.
#' @param root The index of the root vertex or root vertices. If this is a
#' non-empty vector then the supplied vertex ids are used as the roots of the
#' trees (or a single tree if the graph is connected). If it is an empty
#' vector, then the root vertices are automatically calculated based on
#' topological sorting, performed with the opposite mode than the \code{mode}
#' argument. After the vertices have been sorted, one is selected from each
#' component.
#' @param circular Logical scalar, whether to plot the tree in a circular
#' fashion. Defaults to \code{FALSE}, so the tree branches are going bottom-up
#' (or top-down, see the \code{flip.y} argument.
#' @param rootlevel This argument can be useful when drawing forests which are
#' not trees (i.e. they are unconnected and have tree components). It specifies
#' the level of the root vertices for every tree in the forest. It is only
#' considered if the \code{roots} argument is not an empty vector.
#' @param mode Specifies which edges to consider when building the tree. If it
#' is \sQuote{out}, then only the outgoing, if it is \sQuote{in}, then only the
#' incoming edges of a parent are considered. If it is \sQuote{all} then all
#' edges are used (this was the behavior in igraph 0.5 and before). This
#' parameter also influences how the root vertices are calculated, if they are
#' not given. See the \code{roots} parameter.
#' @param flip.y Logical scalar, whether to flip the \sQuote{y} coordinates.
#' The default is flipping because that puts the root vertex on the top.
#' @return A numeric matrix with two columns, and one row for each vertex.
#' @author Tamas Nepusz \email{ntamas@@gmail.com} and Gabor Csardi
#' \email{csardi.gabor@@gmail.com}
#' @references Reingold, E and Tilford, J (1981). Tidier drawing of trees.
#' \emph{IEEE Trans. on Softw. Eng.}, SE-7(2):223--228.
#' @keywords graphs
#' @export
#' @family graph layouts
#' @examples
#'
#' tree <- make_tree(20, 3)
#' plot(tree, layout=layout_as_tree)
#' plot(tree, layout=layout_as_tree(tree, flip.y=FALSE))
#' plot(tree, layout=layout_as_tree(tree, circular=TRUE))
#'
#' tree2 <- make_tree(10, 3) + make_tree(10, 2)
#' plot(tree2, layout=layout_as_tree)
#' plot(tree2, layout=layout_as_tree(tree2, root=c(1,11),
#' rootlevel=c(2,1)))
layout_as_tree <- function(graph, root=numeric(), circular=FALSE,
rootlevel=numeric(), mode=c("out", "in", "all"),
flip.y=TRUE) {
if (!is_igraph(graph)) {
stop("Not a graph object")
}
root <- as.igraph.vs(graph, root)-1
circular <- as.logical(circular)
rootlevel <- as.double(rootlevel)
mode <- switch(igraph.match.arg(mode), "out"=1, "in"=2, "all"=3,
"total"=3)
flip.y <- as.logical(flip.y)
on.exit(.Call(C_R_igraph_finalizer) )
res <- .Call(C_R_igraph_layout_reingold_tilford, graph, root, mode,
rootlevel, circular)
if (flip.y) { res[,2] <- max(res[,2])-res[,2] }
res
}
#' @rdname layout_as_tree
#' @param ... Passed to \code{layout_as_tree}.
#' @export
as_tree <- function(...) layout_spec(layout_as_tree, ...)
#' @export
#' @rdname layout.deprecated
layout.reingold.tilford <- function(..., params = list()) {
do_call(layout_as_tree, .args = c(list(...), params))
}
## ----------------------------------------------------------------
#' Graph layout with vertices on a circle.
#'
#' Place vertices on a circle, in the order of their vertex ids.
#'
#' If you want to order the vertices differently, then permute them using the
#' \code{\link{permute}} function.
#'
#' @param graph The input graph.
#' @param order The vertices to place on the circle, in the order of their
#' desired placement. Vertices that are not included here will be placed at
#' (0,0).
#' @return A numeric matrix with two columns, and one row for each vertex.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @keywords graphs
#' @export
#' @family graph layouts
#' @examples
#'
#' ## Place vertices on a circle, order them according to their
#' ## community
#' \dontrun{
#' library(igraphdata)
#' data(karate)
#' karate_groups <- cluster_optimal(karate)
#' coords <- layout_in_circle(karate, order =
#' order(membership(karate_groups)))
#' V(karate)$label <- sub("Actor ", "", V(karate)$name)
#' V(karate)$label.color <- membership(karate_groups)
#' V(karate)$shape <- "none"
#' plot(karate, layout = coords)
#' }
layout_in_circle <- function(graph, order=V(graph)) {
if (!is_igraph(graph)) {
stop("Not a graph object")
}
order <- as.igraph.vs(graph, order) - 1L
on.exit(.Call(C_R_igraph_finalizer) )
.Call(C_R_igraph_layout_circle, graph, order)
}
#' @rdname layout_in_circle
#' @param ... Passed to \code{layout_in_circle}.
#' @export
in_circle <- function(...) layout_spec(layout_in_circle, ...)
#' @export
#' @rdname layout.deprecated
layout.circle <- function(..., params = list()) {
do_call(layout_in_circle, .args = c(list(...), params))
}
## ----------------------------------------------------------------
#' Choose an appropriate graph layout algorithm automatically
#'
#' This function tries to choose an appropriate graph layout algorithm for the
#' graph, automatically, based on a simple algorithm. See details below.
#'
#' \code{layout_nicely} tries to choose an appropriate layout function for the
#' supplied graph, and uses that to generate the layout. The current
#' implementation works like this: \enumerate{ \item If the graph has a graph
#' attribute called \sQuote{layout}, then this is used. If this attribute is an
#' R function, then it is called, with the graph and any other extra arguments.
#' \item Otherwise, if the graph has vertex attributes called \sQuote{x} and
#' \sQuote{y}, then these are used as coordinates. If the graph has an
#' additional \sQuote{z} vertex attribute, that is also used. \item Otherwise,
#' if the graph is connected and has less than 1000 vertices, the
#' Fruchterman-Reingold layout is used, by calling \code{layout_with_fr}.
#' \item Otherwise the DrL layout is used, \code{layout_with_drl} is called. }
#'
#' @aliases layout.auto
#' @param graph The input graph
#' @param dim Dimensions, should be 2 or 3.
#' @param \dots For \code{layout_nicely} the extra arguments are passed to
#' the real layout function. For \code{nicely} all argument are passed to
#' \code{layout_nicely}.
#' @return A numeric matrix with two or three columns.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @seealso \code{\link{plot.igraph}}
#' @keywords graphs
#' @export
#' @family graph layouts
layout_nicely <- function(graph, dim=2, ...) {
## 1. If there is a 'layout' graph attribute, we just use that.
## 2. Otherwise, if there are vertex attributes called 'x' and 'y',
## we use those (and the 'z' vertex attribute as well, if present).
## 3. Otherwise, if the graph is small (<1000) we use
## the Fruchterman-Reingold layout.
## 5. Otherwise we use the DrL layout generator.
if ("layout" %in% graph_attr_names(graph)) {
lay <- graph_attr(graph, "layout")
if (is.function(lay)) {
lay(graph, ...)
} else {
lay
}
} else if ( all(c("x", "y") %in% vertex_attr_names(graph)) ) {
if ("z" %in% vertex_attr_names(graph)) {
cbind(V(graph)$x, V(graph)$y, V(graph)$z)
} else {
cbind(V(graph)$x, V(graph)$y)
}
} else if (vcount(graph) < 1000) {
layout_with_fr(graph, dim=dim, ...)
} else {
layout_with_drl(graph, dim=dim, ...)
}
}
#' @rdname layout_nicely
#' @export
nicely <- function(...) layout_spec(layout_nicely, ...)
## ----------------------------------------------------------------
#' Simple grid layout
#'
#' This layout places vertices on a rectangulat grid, in two or three
#' dimensions.
#'
#' The function places the vertices on a simple rectangular grid, one after the
#' other. If you want to change the order of the vertices, then see the
#' \code{\link{permute}} function.
#'
#' @aliases layout_on_grid layout.grid layout.grid.3d
#' @param graph The input graph.
#' @param width The number of vertices in a single row of the grid. If this is
#' zero or negative, then for 2d layouts the width of the grid will be the
#' square root of the number of vertices in the graph, rounded up to the next
#' integer. Similarly, it will be the cube root for 3d layouts.
#' @param height The number of vertices in a single column of the grid, for
#' three dimensional layouts. If this is zero or negative, then it is
#' determinted automatically.
#' @param dim Two or three. Whether to make 2d or a 3d layout.
#' @return A two-column or three-column matrix.
#' @author Tamas Nepusz \email{ntamas@@gmail.com}
#' @seealso \code{\link{layout}} for other layout generators
#' @keywords graphs
#' @export
#' @family graph layouts
#' @examples
#'
#' g <- make_lattice( c(3,3) )
#' layout_on_grid(g)
#'
#' g2 <- make_lattice( c(3,3,3) )
#' layout_on_grid(g2, dim = 3)
#'
#' \dontrun{
#' plot(g, layout=layout_on_grid)
#' rglplot(g, layout=layout_on_grid(g, dim = 3))
#' }
layout_on_grid <- function(graph, width = 0, height = 0, dim = 2) {
# Argument checks
if (!is_igraph(graph)) { stop("Not a graph object") }
width <- as.integer(width)
dim <- as.integer(dim)
stopifnot(dim == 2 || dim == 3)
if (dim == 3) { height <- as.integer(height) }
on.exit(.Call(C_R_igraph_finalizer) )
# Function call
if (dim == 2) {
res <- .Call(C_R_igraph_layout_grid, graph, width)
} else {
res <- .Call(C_R_igraph_layout_grid_3d, graph, width, height)
}
res
}
#' @rdname layout_on_grid
#' @param ... Passed to \code{layout_on_grid}.
#' @export
on_grid <- function(...) layout_spec(layout_on_grid, ...)
#' @rdname layout_on_grid
#' @export
layout.grid.3d <- function(graph, width=0, height=0) {
.Deprecated("layout_on_grid", msg = paste0("layout.grid.3d is deprecated from\n",
"igraph 0.8.0, please use layout_on_grid instead"))
# Argument checks
if (!is_igraph(graph)) { stop("Not a graph object") }
width <- as.integer(width)
height <- as.integer(height)
on.exit(.Call(C_R_igraph_finalizer) )
# Function call
res <- .Call(C_R_igraph_layout_grid_3d, graph, width, height)
res
}
## ----------------------------------------------------------------
#' Graph layout with vertices on the surface of a sphere
#'
#' Place vertices on a sphere, approximately uniformly, in the order of their
#' vertex ids.
#'
#' \code{layout_on_sphere} places the vertices (approximately) uniformly on the
#' surface of a sphere, this is thus a 3d layout. It is not clear however what
#' \dQuote{uniformly on a sphere} means.
#'
#' If you want to order the vertices differently, then permute them using the
#' \code{\link{permute}} function.
#'
#' @param graph The input graph.
#' @return A numeric matrix with three columns, and one row for each vertex.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @keywords graphs
#' @export
#' @family graph layouts
layout_on_sphere <- function(graph) {
if (!is_igraph(graph)) {
stop("Not a graph object")
}
on.exit(.Call(C_R_igraph_finalizer) )
.Call(C_R_igraph_layout_sphere, graph)
}
#' @rdname layout_on_sphere
#' @param ... Passed to \code{layout_on_sphere}.
#' @export
on_sphere <- function(...) layout_spec(layout_on_sphere, ...)
#' @export
#' @rdname layout.deprecated
layout.sphere <- function(..., params = list()) {
do_call(layout_on_sphere, .args = c(list(...), params))
}
## ----------------------------------------------------------------
#' Randomly place vertices on a plane or in 3d space
#'
#' This function uniformly randomly places the vertices of the graph in two or
#' three dimensions.
#'
#' Randomly places vertices on a [-1,1] square (in 2d) or in a cube (in 3d). It
#' is probably a useless layout, but it can use as a starting point for other
#' layout generators.
#'
#' @param graph The input graph.
#' @param dim Integer scalar, the dimension of the space to use. It must be 2
#' or 3.
#' @return A numeric matrix with two or three columns.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @keywords graphs
#' @export
#' @family graph layouts
layout_randomly <- function(graph, dim=2) {
if (!is_igraph(graph)) {
stop("Not a graph object")
}
if (dim==2) {
on.exit(.Call(C_R_igraph_finalizer) )
.Call(C_R_igraph_layout_random, graph)
} else if (dim==3) {
on.exit(.Call(C_R_igraph_finalizer) )
.Call(C_R_igraph_layout_random_3d, graph)
} else {
stop("Invalid `dim' value");
}
}
#' @rdname layout_randomly
#' @param ... Parameters to pass to \code{layout_randomly}.
#' @export
randomly <- function(...) layout_spec(layout_randomly, ...)
#' Deprecated layout functions
#'
#' Please use the new names, see \code{\link{layout_}}.
#'
#' @param ... Passed to the new layout functions.
#' @param params Passed to the new layout functions as arguments.
#' @export
#' @rdname layout.deprecated
layout.random <- function(..., params = list()) {
do_call(layout_randomly, .args = c(list(...), params))
}
## ----------------------------------------------------------------
#' The Davidson-Harel layout algorithm
#'
#' Place vertices of a graph on the plane, according to the simulated annealing
#' algorithm by Davidson and Harel.
#'
#' This function implements the algorithm by Davidson and Harel, see Ron
#' Davidson, David Harel: Drawing Graphs Nicely Using Simulated Annealing. ACM
#' Transactions on Graphics 15(4), pp. 301-331, 1996.
#'
#' The algorithm uses simulated annealing and a sophisticated energy function,
#' which is unfortunately hard to parameterize for different graphs. The
#' original publication did not disclose any parameter values, and the ones
#' below were determined by experimentation.
#'
#' The algorithm consists of two phases, an annealing phase, and a fine-tuning
#' phase. There is no simulated annealing in the second phase.
#'
#' Our implementation tries to follow the original publication, as much as
#' possible. The only major difference is that coordinates are explicitly kept
#' within the bounds of the rectangle of the layout.
#'
#' @aliases layout.davidson.harel
#' @param graph The graph to lay out. Edge directions are ignored.
#' @param coords Optional starting positions for the vertices. If this argument
#' is not \code{NULL} then it should be an appropriate matrix of starting
#' coordinates.
#' @param maxiter Number of iterations to perform in the first phase.
#' @param fineiter Number of iterations in the fine tuning phase.
#' @param cool.fact Cooling factor.
#' @param weight.node.dist Weight for the node-node distances component of the
#' energy function.
#' @param weight.border Weight for the distance from the border component of
#' the energy function. It can be set to zero, if vertices are allowed to sit
#' on the border.
#' @param weight.edge.lengths Weight for the edge length component of the
#' energy function.
#' @param weight.edge.crossings Weight for the edge crossing component of the
#' energy function.
#' @param weight.node.edge.dist Weight for the node-edge distance component of
#' the energy function.
#' @return A two- or three-column matrix, each row giving the coordinates of a
#' vertex, according to the ids of the vertex ids.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @seealso \code{\link{layout_with_fr}},
#' \code{\link{layout_with_kk}} for other layout algorithms.
#' @references Ron Davidson, David Harel: Drawing Graphs Nicely Using Simulated
#' Annealing. \emph{ACM Transactions on Graphics} 15(4), pp. 301-331, 1996.
#' @export
#' @family graph layouts
#' @examples
#'
#' set.seed(42)
#' ## Figures from the paper
#' g_1b <- make_star(19, mode="undirected") + path(c(2:19, 2)) +
#' path(c(seq(2, 18, by=2), 2))
#' plot(g_1b, layout=layout_with_dh)
#'
#' g_2 <- make_lattice(c(8, 3)) + edges(1,8, 9,16, 17,24)
#' plot(g_2, layout=layout_with_dh)
#'
#' g_3 <- make_empty_graph(n=70)
#' plot(g_3, layout=layout_with_dh)
#'
#' g_4 <- make_empty_graph(n=70, directed=FALSE) + edges(1:70)
#' plot(g_4, layout=layout_with_dh, vertex.size=5, vertex.label=NA)
#'
#' g_5a <- make_ring(24)
#' plot(g_5a, layout=layout_with_dh, vertex.size=5, vertex.label=NA)
#'
#' g_5b <- make_ring(40)
#' plot(g_5b, layout=layout_with_dh, vertex.size=5, vertex.label=NA)
#'
#' g_6 <- make_lattice(c(2,2,2))
#' plot(g_6, layout=layout_with_dh)
#'
#' g_7 <- graph_from_literal(1:3:5 -- 2:4:6)
#' plot(g_7, layout=layout_with_dh, vertex.label=V(g_7)$name)
#'
#' g_8 <- make_ring(5) + make_ring(10) + make_ring(5) +
#' edges(1,6, 2,8, 3, 10, 4,12, 5,14,
#' 7,16, 9,17, 11,18, 13,19, 15,20)
#' plot(g_8, layout=layout_with_dh, vertex.size=5, vertex.label=NA)
#'
#' g_9 <- make_lattice(c(3,2,2))
#' plot(g_9, layout=layout_with_dh, vertex.size=5, vertex.label=NA)
#'
#' g_10 <- make_lattice(c(6,6))
#' plot(g_10, layout=layout_with_dh, vertex.size=5, vertex.label=NA)
#'
#' g_11a <- make_tree(31, 2, mode="undirected")
#' plot(g_11a, layout=layout_with_dh, vertex.size=5, vertex.label=NA)
#'
#' g_11b <- make_tree(21, 4, mode="undirected")
#' plot(g_11b, layout=layout_with_dh, vertex.size=5, vertex.label=NA)
#'
#' g_12 <- make_empty_graph(n=37, directed=FALSE) +
#' path(1:5,10,22,31,37:33,27,16,6,1) + path(6,7,11,9,10) + path(16:22) +
#' path(27:31) + path(2,7,18,28,34) + path(3,8,11,19,29,32,35) +
#' path(4,9,20,30,36) + path(1,7,12,14,19,24,26,30,37) +
#' path(5,9,13,15,19,23,25,28,33) + path(3,12,16,25,35,26,22,13,3)
#' plot(g_12, layout=layout_with_dh, vertex.size=5, vertex.label=NA)
layout_with_dh <- function(graph, coords=NULL, maxiter=10,
fineiter=max(10, log2(vcount(graph))), cool.fact=0.75,
weight.node.dist=1.0, weight.border=0.0,
weight.edge.lengths=edge_density(graph) / 10,
weight.edge.crossings=1.0 - sqrt(edge_density(graph)),
weight.node.edge.dist=0.2 * (1-edge_density(graph))) {
# Argument checks
if (!is_igraph(graph)) { stop("Not a graph object") }
if (!is.null(coords)) {
coords <- as.matrix(structure(as.double(coords), dim=dim(coords)))
use.seed <- TRUE
} else {
coords <- matrix(NA_real_, ncol=2, nrow=0)
use.seed <- FALSE
}
maxiter <- as.integer(maxiter)
fineiter <- as.integer(fineiter)
cool.fact <- as.numeric(cool.fact)
weight.node.dist <- as.numeric(weight.node.dist)
weight.border <- as.numeric(weight.border)
weight.edge.lengths <- as.numeric(weight.edge.lengths)
weight.edge.crossings <- as.numeric(weight.edge.crossings)
weight.node.edge.dist <- as.numeric(weight.node.edge.dist)
on.exit(.Call(C_R_igraph_finalizer) )
# Function call
res <- .Call(C_R_igraph_layout_davidson_harel, graph, coords, use.seed,
maxiter, fineiter, cool.fact, weight.node.dist,
weight.border, weight.edge.lengths, weight.edge.crossings,
weight.node.edge.dist)
res
}
#' @rdname layout_with_dh
#' @param ... Passed to \code{layout_with_dh}.
#' @export
with_dh <- function(...) layout_spec(layout_with_dh, ...)
## ----------------------------------------------------------------
#' The Fruchterman-Reingold layout algorithm
#'
#' Place vertices on the plane using the force-directed layout algorithm by
#' Fruchterman and Reingold.
#'
#' See the referenced paper below for the details of the algorithm.
#'
#' This function was rewritten from scratch in igraph version 0.8.0.
#'
#' @param graph The graph to lay out. Edge directions are ignored.
#' @param coords Optional starting positions for the vertices. If this argument
#' is not \code{NULL} then it should be an appropriate matrix of starting
#' coordinates.
#' @param dim Integer scalar, 2 or 3, the dimension of the layout. Two
#' dimensional layouts are places on a plane, three dimensional ones in the 3d
#' space.
#' @param niter Integer scalar, the number of iterations to perform.
#' @param start.temp Real scalar, the start temperature. This is the maximum
#' amount of movement alloved along one axis, within one step, for a vertex.
#' Currently it is decreased linearly to zero during the iteration.
#' @param grid Character scalar, whether to use the faster, but less accurate
#' grid based implementation of the algorithm. By default (\dQuote{auto}), the
#' grid-based implementation is used if the graph has more than one thousand
#' vertices.
#' @param weights A vector giving edge weights. The \code{weight} edge
#' attribute is used by default, if present. If weights are given, then the
#' attraction along the edges will be multiplied by the given edge weights.
#' This places vertices connected with a highly weighted edge closer to
#' each other.
#' @param minx If not \code{NULL}, then it must be a numeric vector that gives
#' lower boundaries for the \sQuote{x} coordinates of the vertices. The length
#' of the vector must match the number of vertices in the graph.
#' @param maxx Similar to \code{minx}, but gives the upper boundaries.
#' @param miny Similar to \code{minx}, but gives the lower boundaries of the
#' \sQuote{y} coordinates.
#' @param maxy Similar to \code{minx}, but gives the upper boundaries of the
#' \sQuote{y} coordinates.
#' @param minz Similar to \code{minx}, but gives the lower boundaries of the
#' \sQuote{z} coordinates.
#' @param maxz Similar to \code{minx}, but gives the upper boundaries of the
#' \sQuote{z} coordinates.
#' @param coolexp,maxdelta,area,repulserad These arguments are not supported
#' from igraph version 0.8.0 and are ignored (with a warning).
#' @param maxiter A deprecated synonym of \code{niter}, for compatibility.
#' @return A two- or three-column matrix, each row giving the coordinates of a
#' vertex, according to the ids of the vertex ids.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @seealso \code{\link{layout_with_drl}}, \code{\link{layout_with_kk}} for
#' other layout algorithms.
#' @references Fruchterman, T.M.J. and Reingold, E.M. (1991). Graph Drawing by
#' Force-directed Placement. \emph{Software - Practice and Experience},
#' 21(11):1129-1164.
#' @export
#' @family graph layouts
#' @keywords graphs
#' @examples
#'
#' # Fixing ego
#' g <- sample_pa(20, m=2)
#' minC <- rep(-Inf, vcount(g))
#' maxC <- rep(Inf, vcount(g))
#' minC[1] <- maxC[1] <- 0
#' co <- layout_with_fr(g, minx=minC, maxx=maxC,
#' miny=minC, maxy=maxC)
#' co[1,]
#' plot(g, layout=co, vertex.size=30, edge.arrow.size=0.2,
#' vertex.label=c("ego", rep("", vcount(g)-1)), rescale=FALSE,
#' xlim=range(co[,1]), ylim=range(co[,2]), vertex.label.dist=0,
#' vertex.label.color="red")
#' axis(1)
#' axis(2)
#'
layout_with_fr <- function(graph, coords=NULL, dim=2,
niter=500, start.temp=sqrt(vcount(graph)),
grid=c("auto", "grid", "nogrid"), weights=NULL,
minx=NULL, maxx=NULL, miny=NULL, maxy=NULL,
minz=NULL, maxz=NULL,
coolexp, maxdelta, area, repulserad, maxiter) {
# Argument checks
if (!is_igraph(graph)) { stop("Not a graph object") }
if (!is.null(coords)) {
coords <- as.matrix(structure(as.double(coords), dim=dim(coords)))
}
dim <- as.integer(dim)
if (dim != 2L && dim != 3L) {
stop("Dimension must be two or three")
}
if (!missing(niter) && !missing(maxiter)) {
stop("Both `niter' and `maxiter' are given, give only one of them")
}
if (!missing(maxiter)) niter <- maxiter
niter <- as.integer(niter)
start.temp <- as.numeric(start.temp)
grid <- igraph.match.arg(grid)
grid <- switch(grid, "grid"=0L, "nogrid"=1L, "auto"=2L)
if (is.null(weights) && "weight" %in% edge_attr_names(graph)) {
weights <- E(graph)$weight
}
if (!is.null(weights) && any(!is.na(weights))) {
weights <- as.numeric(weights)
} else {
weights <- NULL
}
if (!is.null(minx)) minx <- as.numeric(minx)
if (!is.null(maxx)) maxx <- as.numeric(maxx)
if (!is.null(miny)) miny <- as.numeric(miny)
if (!is.null(maxy)) maxy <- as.numeric(maxy)
if (!is.null(minz)) minz <- as.numeric(minz)
if (!is.null(maxz)) maxz <- as.numeric(maxz)
if (!missing(coolexp)) {
warning("Argument `coolexp' is deprecated and has no effect")
}
if (!missing(maxdelta)) {
warning("Argument `maxdelta' is deprecated and has no effect")
}
if (!missing(area)) {
warning("Argument `area' is deprecated and has no effect")
}
if (!missing(repulserad)) {
warning("Argument `repulserad' is deprecated and has no effect")
}
on.exit(.Call(C_R_igraph_finalizer) )
if (dim==2) {
res <- .Call(C_R_igraph_layout_fruchterman_reingold, graph, coords,
niter, start.temp, weights, minx, maxx, miny, maxy, grid)
} else {
res <- .Call(C_R_igraph_layout_fruchterman_reingold_3d, graph, coords,
niter, start.temp, weights, minx, maxx, miny, maxy,
minz, maxz)
}
res
}
#' @rdname layout_with_fr
#' @param ... Passed to \code{layout_with_fr}.
#' @export
with_fr <- function(...) layout_spec(layout_with_fr, ...)
#' @export
#' @rdname layout.deprecated
layout.fruchterman.reingold <- function(..., params = list()) {
do_call(layout_with_fr, .args = c(list(...), params))
}
## ----------------------------------------------------------------
#' The GEM layout algorithm
#'
#' Place vertices on the plane using the GEM force-directed layout algorithm.
#'
#' See the referenced paper below for the details of the algorithm.
#'
#' @aliases layout.gem
#' @param graph The input graph. Edge directions are ignored.
#' @param coords If not \code{NULL}, then the starting coordinates should be
#' given here, in a two or three column matrix, depending on the \code{dim}
#' argument.
#' @param maxiter The maximum number of iterations to perform. Updating a
#' single vertex counts as an iteration. A reasonable default is 40 * n * n,
#' where n is the number of vertices. The original paper suggests 4 * n * n,
#' but this usually only works if the other parameters are set up carefully.
#' @param temp.max The maximum allowed local temperature. A reasonable default
#' is the number of vertices.
#' @param temp.min The global temperature at which the algorithm terminates
#' (even before reaching \code{maxiter} iterations). A reasonable default is
#' 1/10.
#' @param temp.init Initial local temperature of all vertices. A reasonable
#' default is the square root of the number of vertices.
#' @return A numeric matrix with two columns, and as many rows as the number of
#' vertices.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @seealso \code{\link{layout_with_fr}},
#' \code{\link{plot.igraph}}, \code{\link{tkplot}}
#' @references Arne Frick, Andreas Ludwig, Heiko Mehldau: A Fast Adaptive
#' Layout Algorithm for Undirected Graphs, \emph{Proc. Graph Drawing 1994},
#' LNCS 894, pp. 388-403, 1995.
#' @export
#' @family graph layouts
#' @keywords graphs
#' @examples
#'
#' set.seed(42)
#' g <- make_ring(10)
#' plot(g, layout=layout_with_gem)
#'
layout_with_gem <- function(graph, coords=NULL, maxiter=40*vcount(graph)^2,
temp.max=vcount(graph), temp.min=1/10,
temp.init=sqrt(vcount(graph))) {
# Argument checks
if (!is_igraph(graph)) { stop("Not a graph object") }
if (!is.null(coords)) {
coords <- as.matrix(structure(as.double(coords), dim=dim(coords)))
use.seed <- TRUE
} else {
coords <- matrix(NA_real_, ncol=2, nrow=0)
use.seed <- FALSE
}
maxiter <- as.integer(maxiter)
temp.max <- as.numeric(temp.max)
temp.min <- as.numeric(temp.min)
temp.init <- as.numeric(temp.init)
on.exit(.Call(C_R_igraph_finalizer) )
# Function call
res <- .Call(C_R_igraph_layout_gem, graph, coords, use.seed, maxiter,
temp.max, temp.min, temp.init)
res
}
#' @rdname layout_with_gem
#' @param ... Passed to \code{layout_with_gem}.
#' @export
with_gem <- function(...) layout_spec(layout_with_gem, ...)
## ----------------------------------------------------------------
#' The graphopt layout algorithm
#'
#' A force-directed layout algorithm, that scales relatively well to large
#' graphs.
#'
#' \code{layout_with_graphopt} is a port of the graphopt layout algorithm by Michael
#' Schmuhl. graphopt version 0.4.1 was rewritten in C and the support for
#' layers was removed (might be added later) and a code was a bit reorganized
#' to avoid some unneccessary steps is the node charge (see below) is zero.
#'
#' graphopt uses physical analogies for defining attracting and repelling
#' forces among the vertices and then the physical system is simulated until it
#' reaches an equilibrium. (There is no simulated annealing or anything like
#' that, so a stable fixed point is not guaranteed.)
#'
#' See also \url{http://www.schmuhl.org/graphopt/} for the original graphopt.
#'
#' @aliases layout.graphopt
#' @param graph The input graph.
#' @param start If given, then it should be a matrix with two columns and one
#' line for each vertex. This matrix will be used as starting positions for the
#' algorithm. If not given, then a random starting matrix is used.
#' @param niter Integer scalar, the number of iterations to perform. Should be
#' a couple of hundred in general. If you have a large graph then you might
#' want to only do a few iterations and then check the result. If it is not
#' good enough you can feed it in again in the \code{start} argument. The
#' default value is 500.
#' @param charge The charge of the vertices, used to calculate electric
#' repulsion. The default is 0.001.
#' @param mass The mass of the vertices, used for the spring forces. The
#' default is 30.
#' @param spring.length The length of the springs, an integer number. The
#' default value is zero.
#' @param spring.constant The spring constant, the default value is one.
#' @param max.sa.movement Real constant, it gives the maximum amount of
#' movement allowed in a single step along a single axis. The default value is
#' 5.
#' @return A numeric matrix with two columns, and a row for each vertex.
#' @author Michael Schmuhl for the original graphopt code, rewritten and
#' wrapped by Gabor Csardi \email{csardi.gabor@@gmail.com}.
#' @keywords graphs
#' @export
#' @family graph layouts
layout_with_graphopt <- function(graph, start=NULL, niter=500, charge=0.001,
mass=30, spring.length=0, spring.constant=1,
max.sa.movement=5) {
if (!is_igraph(graph)) {
stop("Not a graph object")
}
if (!is.null(start)) {
start <- structure(as.numeric(start), dim=dim(start))
}
niter <- as.double(niter)
charge <- as.double(charge)
mass <- as.double(mass)
spring.length <- as.double(spring.length)
spring.constant <- as.double(spring.constant)
max.sa.movement <- as.double(max.sa.movement)
on.exit(.Call(C_R_igraph_finalizer) )
.Call(C_R_igraph_layout_graphopt, graph, niter, charge, mass,
spring.length, spring.constant, max.sa.movement, start)
}
#' @rdname layout_with_graphopt
#' @param ... Passed to \code{layout_with_graphopt}.
#' @export
with_graphopt <- function(...) layout_spec(layout_with_graphopt, ...)
## ----------------------------------------------------------------
#' The Kamada-Kawai layout algorithm
#'
#' Place the vertices on the plane, or in the 3d space, based on a phyisical
#' model of springs.
#'
#' See the referenced paper below for the details of the algorithm.
#'
#' This function was rewritten from scratch in igraph version 0.8.0 and it
#' follows truthfully the original publication by Kamada and Kawai now.
#'
#' @param graph The input graph. Edge directions are ignored.
#' @param coords If not \code{NULL}, then the starting coordinates should be
#' given here, in a two or three column matrix, depending on the \code{dim}
#' argument.
#' @param dim Integer scalar, 2 or 3, the dimension of the layout. Two
#' dimensional layouts are places on a plane, three dimensional ones in the 3d
#' space.
#' @param maxiter The maximum number of iterations to perform. The algorithm
#' might terminate earlier, see the \code{epsilon} argument.
#' @param epsilon Numeric scalar, the algorithm terminates, if the maximal
#' delta is less than this. (See the reference below for what delta means.) If
#' you set this to zero, then the function always performs \code{maxiter}
#' iterations.
#' @param kkconst Numeric scalar, the Kamada-Kawai vertex attraction constant.
#' Typical (and default) value is the number of vertices.
#' @param weights Edge weights, larger values will result longer edges.
#' Note that this is opposite to \code{\link{layout_with_fr}}.
#' @param minx If not \code{NULL}, then it must be a numeric vector that gives
#' lower boundaries for the \sQuote{x} coordinates of the vertices. The length
#' of the vector must match the number of vertices in the graph.
#' @param maxx Similar to \code{minx}, but gives the upper boundaries.
#' @param miny Similar to \code{minx}, but gives the lower boundaries of the
#' \sQuote{y} coordinates.
#' @param maxy Similar to \code{minx}, but gives the upper boundaries of the
#' \sQuote{y} coordinates.
#' @param minz Similar to \code{minx}, but gives the lower boundaries of the
#' \sQuote{z} coordinates.
#' @param maxz Similar to \code{minx}, but gives the upper boundaries of the
#' \sQuote{z} coordinates.
#' @param niter,sigma,initemp,coolexp These arguments are not supported from
#' igraph version 0.8.0 and are ignored (with a warning).
#' @param start Deprecated synonym for \code{coords}, for compatibility.
#' @return A numeric matrix with two (dim=2) or three (dim=3) columns, and as
#' many rows as the number of vertices, the x, y and potentially z coordinates
#' of the vertices.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @seealso \code{\link{layout_with_drl}}, \code{\link{plot.igraph}},
#' \code{\link{tkplot}}
#' @references Kamada, T. and Kawai, S.: An Algorithm for Drawing General
#' Undirected Graphs. \emph{Information Processing Letters}, 31/1, 7--15, 1989.
#' @export
#' @family graph layouts
#' @keywords graphs
#' @examples
#'
#' g <- make_ring(10)
#' E(g)$weight <- rep(1:2, length.out=ecount(g))
#' plot(g, layout=layout_with_kk, edge.label=E(g)$weight)
#'
layout_with_kk <- function(graph, coords=NULL, dim=2,
maxiter=50*vcount(graph),
epsilon=0.0, kkconst=vcount(graph),
weights=NULL, minx=NULL, maxx=NULL,
miny=NULL, maxy=NULL, minz=NULL, maxz=NULL,
niter, sigma, initemp, coolexp, start) {
# Argument checks
if (!missing(coords) && !missing(start)) {
stop("Both `coords' and `start' are given, give only one of them.")
}
if (!missing(start)) coords <- start
if (!is_igraph(graph)) { stop("Not a graph object") }
if (!is.null(coords)) {
coords <- as.matrix(structure(as.double(coords), dim=dim(coords)))
}
dim <- as.integer(dim)
if (dim != 2L && dim != 3L) {
stop("Dimension must be two or three")
}
maxiter <- as.integer(maxiter)
epsilon <- as.numeric(epsilon)
kkconst <- as.numeric(kkconst)
if (is.null(weights) && "weight" %in% edge_attr_names(graph)) {
weights <- E(graph)$weight
}
if (!is.null(weights) && any(!is.na(weights))) {
weights <- as.numeric(weights)
} else {
weights <- NULL
}
if (!is.null(minx)) minx <- as.numeric(minx)
if (!is.null(maxx)) maxx <- as.numeric(maxx)
if (!is.null(miny)) miny <- as.numeric(miny)
if (!is.null(maxy)) maxy <- as.numeric(maxy)
if (!is.null(minz)) minz <- as.numeric(minz)
if (!is.null(maxz)) maxz <- as.numeric(maxz)
if (!missing(niter)) {
warning("Argument `niter' is deprecated and has no effect")
}
if (!missing(sigma)) {
warning("Argument `sigma' is deprecated and has no effect")
}
if (!missing(initemp)) {
warning("Argument `initemp' is deprecated and has no effect")
}
if (!missing(coolexp)) {
warning("Argument `coolexp' is deprecated and has no effect")
}
on.exit(.Call(C_R_igraph_finalizer) )
# Function call
if (dim == 2) {
res <- .Call(C_R_igraph_layout_kamada_kawai, graph, coords, maxiter,
epsilon, kkconst, weights, minx, maxx, miny, maxy)
} else {
res <- .Call(C_R_igraph_layout_kamada_kawai_3d, graph, coords, maxiter,
epsilon, kkconst, weights, minx, maxx, miny, maxy, minz,
maxz)
}
res
}
#' @rdname layout_with_kk
#' @param ... Passed to \code{layout_with_kk}.
#' @export
#'
with_kk <- function(...) layout_spec(layout_with_kk, ...)
#' @export
#' @rdname layout.deprecated
layout.kamada.kawai <- function(..., params = list()) {
do_call(layout_with_kk, .args = c(list(...), params))
}
## ----------------------------------------------------------------
#' Large Graph Layout
#'
#' A layout generator for larger graphs.
#'
#' \code{layout_with_lgl} is for large connected graphs, it is similar to the layout
#' generator of the Large Graph Layout software
#' (\url{http://lgl.sourceforge.net/}).
#'
#' @param graph The input graph
#' @param maxiter The maximum number of iterations to perform (150).
#' @param maxdelta The maximum change for a vertex during an iteration (the
#' number of vertices).
#' @param area The area of the surface on which the vertices are placed (square
#' of the number of vertices).
#' @param coolexp The cooling exponent of the simulated annealing (1.5).
#' @param repulserad Cancellation radius for the repulsion (the \code{area}
#' times the number of vertices).
#' @param cellsize The size of the cells for the grid. When calculating the
#' repulsion forces between vertices only vertices in the same or neighboring
#' grid cells are taken into account (the fourth root of the number of
#' \code{area}.
#' @param root The id of the vertex to place at the middle of the layout. The
#' default value is -1 which means that a random vertex is selected.
#' @return A numeric matrix with two columns and as many rows as vertices.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @keywords graphs
#' @export
#' @family graph layouts
layout_with_lgl <- function(graph, maxiter=150, maxdelta=vcount(graph),
area=vcount(graph)^2, coolexp=1.5,
repulserad=area * vcount(graph),
cellsize=sqrt(sqrt(area)), root=NULL) {
if (!is_igraph(graph)) {
stop("Not a graph object")
}
if (is.null(root)) {
root <- -1
} else {
root <- as.igraph.vs(graph, root)-1
}
on.exit(.Call(C_R_igraph_finalizer) )
.Call(C_R_igraph_layout_lgl, graph, as.double(maxiter),
as.double(maxdelta), as.double(area), as.double(coolexp),
as.double(repulserad), as.double(cellsize), root)
}
#' @rdname layout_with_lgl
#' @param ... Passed to \code{layout_with_lgl}.
#' @export
with_lgl <- function(...) layout_spec(layout_with_lgl, ...)
#' @export
#' @rdname layout.deprecated
layout.lgl <- function(..., params = list()) {
do_call(layout_with_lgl, .args = c(list(...), params))
}
## ----------------------------------------------------------------
#' Graph layout by multidimensional scaling
#'
#' Multidimensional scaling of some distance matrix defined on the vertices of
#' a graph.
#'
#' \code{layout_with_mds} uses metric multidimensional scaling for generating the
#' coordinates. Multidimensional scaling aims to place points from a higher
#' dimensional space in a (typically) 2 dimensional plane, so that the distance
#' between the points are kept as much as this is possible.
#'
#' By default igraph uses the shortest path matrix as the distances between the
#' nodes, but the user can override this via the \code{dist} argument.
#'
#' This function generates the layout separately for each graph component and
#' then merges them via \code{\link{merge_coords}}.
#'
#' @aliases layout.mds
#' @param graph The input graph.
#' @param dist The distance matrix for the multidimensional scaling. If
#' \code{NULL} (the default), then the unweighted shortest path matrix is used.
#' @param dim \code{layout_with_mds} supports dimensions up to the number of nodes
#' minus one, but only if the graph is connected; for unconnected graphs, the
#' only possible values is 2. This is because \code{merge_coords} only works in
#' 2D.
#' @param options This is currently ignored, as ARPACK is not used any more for
#' solving the eigenproblem
#' @return A numeric matrix with \code{dim} columns.
#' @author Tamas Nepusz \email{ntamas@@gmail.com} and Gabor Csardi
#' \email{csardi.gabor@@gmail.com}
#' @seealso \code{\link{layout}}, \code{\link{plot.igraph}}
#' @references Cox, T. F. and Cox, M. A. A. (2001) \emph{Multidimensional
#' Scaling}. Second edition. Chapman and Hall.
#' @export
#' @family graph layouts
#' @keywords graphs
#' @examples
#'
#' g <- sample_gnp(100, 2/100)
#' l <- layout_with_mds(g)
#' plot(g, layout=l, vertex.label=NA, vertex.size=3)
layout_with_mds <- function(graph, dist=NULL, dim=2,
options=arpack_defaults) {
# Argument checks
if (!is_igraph(graph)) { stop("Not a graph object") }
if (!is.null(dist)) dist <- structure(as.double(dist), dim=dim(dist))
dim <- as.integer(dim)
on.exit(.Call(C_R_igraph_finalizer) )
# Function call
res <- .Call(C_R_igraph_layout_mds, graph, dist, dim)
res
}
#' @rdname layout_with_mds
#' @param ... Passed to \code{layout_with_mds}.
#' @export
with_mds <- function(...) layout_spec(layout_with_mds, ...)
## ----------------------------------------------------------------
#' The Sugiyama graph layout generator
#'
#' Sugiyama layout algorithm for layered directed acyclic graphs. The algorithm
#' minimized edge crossings.
#'
#' This layout algorithm is designed for directed acyclic graphs where each
#' vertex is assigned to a layer. Layers are indexed from zero, and vertices of
#' the same layer will be placed on the same horizontal line. The X coordinates
#' of vertices within each layer are decided by the heuristic proposed by
#' Sugiyama et al. to minimize edge crossings.
#'
#' You can also try to lay out undirected graphs, graphs containing cycles, or
#' graphs without an a priori layered assignment with this algorithm. igraph
#' will try to eliminate cycles and assign vertices to layers, but there is no
#' guarantee on the quality of the layout in such cases.
#'
#' The Sugiyama layout may introduce \dQuote{bends} on the edges in order to
#' obtain a visually more pleasing layout. This is achieved by adding dummy
#' nodes to edges spanning more than one layer. The resulting layout assigns
#' coordinates not only to the nodes of the original graph but also to the
#' dummy nodes. The layout algorithm will also return the extended graph with
#' the dummy nodes.
#'
#' For more details, see the reference below.
#'
#' @aliases layout.sugiyama
#' @param graph The input graph.
#' @param layers A numeric vector or \code{NULL}. If not \code{NULL}, then it
#' should specify the layer index of the vertices. Layers are numbered from
#' one. If \code{NULL}, then igraph calculates the layers automatically.
#' @param hgap Real scalar, the minimum horizontal gap between vertices in the
#' same layer.
#' @param vgap Real scalar, the distance between layers.
#' @param maxiter Integer scalar, the maximum number of iterations in the
#' crossing minimization stage. 100 is a reasonable default; if you feel that
#' you have too many edge crossings, increase this.
#' @param weights Optional edge weight vector. If \code{NULL}, then the
#' 'weight' edge attribute is used, if there is one. Supply \code{NA} here and
#' igraph ignores the edge weights. These are used only if the graph
#' contains cycles; igraph will tend to reverse edges with smaller weights
#' when breaking the cycles.
#' @param attributes Which graph/vertex/edge attributes to keep in the extended
#' graph. \sQuote{default} keeps the \sQuote{size}, \sQuote{size2},
#' \sQuote{shape}, \sQuote{label} and \sQuote{color} vertex attributes and the
#' \sQuote{arrow.mode} and \sQuote{arrow.size} edge attributes. \sQuote{all}
#' keep all graph, vertex and edge attributes, \sQuote{none} keeps none of
#' them.
#' @return A list with the components: \item{layout}{The layout, a two-column
#' matrix, for the original graph vertices.} \item{layout.dummy}{The layout for
#' the dummy vertices, a two column matrix.} \item{extd_graph}{The original
#' graph, extended with dummy vertices. The \sQuote{dummy} vertex attribute is
#' set on this graph, it is a logical attributes, and it tells you whether the
#' vertex is a dummy vertex. The \sQuote{layout} graph attribute is also set,
#' and it is the layout matrix for all (original and dummy) vertices.}
#' @author Tamas Nepusz \email{ntamas@@gmail.com}
#' @references K. Sugiyama, S. Tagawa and M. Toda, "Methods for Visual
#' Understanding of Hierarchical Systems". IEEE Transactions on Systems, Man
#' and Cybernetics 11(2):109-125, 1981.
#' @export
#' @importFrom utils head
#' @family graph layouts
#' @keywords graphs
#' @examples
#'
#' ## Data taken from http://tehnick-8.narod.ru/dc_clients/
#' DC <- graph_from_literal("DC++" -+
#' "LinuxDC++":"BCDC++":"EiskaltDC++":"StrongDC++":"DiCe!++",
#' "LinuxDC++" -+ "FreeDC++", "BCDC++" -+ "StrongDC++",
#' "FreeDC++" -+ "BMDC++":"EiskaltDC++",
#' "StrongDC++" -+ "AirDC++":"zK++":"ApexDC++":"TkDC++",
#' "StrongDC++" -+ "StrongDC++ SQLite":"RSX++",
#' "ApexDC++" -+ "FlylinkDC++ ver <= 4xx",
#' "ApexDC++" -+ "ApexDC++ Speed-Mod":"DiCe!++",
#' "StrongDC++ SQLite" -+ "FlylinkDC++ ver >= 5xx",
#' "ApexDC++ Speed-Mod" -+ "FlylinkDC++ ver <= 4xx",
#' "ApexDC++ Speed-Mod" -+ "GreylinkDC++",
#' "FlylinkDC++ ver <= 4xx" -+ "FlylinkDC++ ver >= 5xx",
#' "FlylinkDC++ ver <= 4xx" -+ AvaLink,
#' "GreylinkDC++" -+ AvaLink:"RayLinkDC++":"SparkDC++":PeLink)
#'
#' ## Use edge types
#' E(DC)$lty <- 1
#' E(DC)["BCDC++" %->% "StrongDC++"]$lty <- 2
#' E(DC)["FreeDC++" %->% "EiskaltDC++"]$lty <- 2
#' E(DC)["ApexDC++" %->% "FlylinkDC++ ver <= 4xx"]$lty <- 2
#' E(DC)["ApexDC++" %->% "DiCe!++"]$lty <- 2
#' E(DC)["StrongDC++ SQLite" %->% "FlylinkDC++ ver >= 5xx"]$lty <- 2
#' E(DC)["GreylinkDC++" %->% "AvaLink"]$lty <- 2
#'
#' ## Layers, as on the plot
#' layers <- list(c("DC++"),
#' c("LinuxDC++", "BCDC++"),
#' c("FreeDC++", "StrongDC++"),
#' c("BMDC++", "EiskaltDC++", "AirDC++", "zK++", "ApexDC++",
#' "TkDC++", "RSX++"),
#' c("StrongDC++ SQLite", "ApexDC++ Speed-Mod", "DiCe!++"),
#' c("FlylinkDC++ ver <= 4xx", "GreylinkDC++"),
#' c("FlylinkDC++ ver >= 5xx", "AvaLink", "RayLinkDC++",
#' "SparkDC++", "PeLink"))
#'
#' ## Check that we have all nodes
#' all(sort(unlist(layers)) == sort(V(DC)$name))
#'
#' ## Add some graphical parameters
#' V(DC)$color <- "white"
#' V(DC)$shape <- "rectangle"
#' V(DC)$size <- 20
#' V(DC)$size2 <- 10
#' V(DC)$label <- lapply(V(DC)$name, function(x)
#' paste(strwrap(x, 12), collapse="\n"))
#' E(DC)$arrow.size <- 0.5
#'
#' ## Create a similar layout using the predefined layers
#' lay1 <- layout_with_sugiyama(DC, layers=apply(sapply(layers,
#' function(x) V(DC)$name %in% x), 1, which))
#'
#' ## Simple plot, not very nice
#' par(mar=rep(.1, 4))
#' plot(DC, layout=lay1$layout, vertex.label.cex=0.5)
#'
#' ## Sugiyama plot
#' plot(lay1$extd_graph, vertex.label.cex=0.5)
#'
#' ## The same with automatic layer calculation
#' ## Keep vertex/edge attributes in the extended graph
#' lay2 <- layout_with_sugiyama(DC, attributes="all")
#' plot(lay2$extd_graph, vertex.label.cex=0.5)
#'
#' ## Another example, from the following paper:
#' ## Markus Eiglsperger, Martin Siebenhaller, Michael Kaufmann:
#' ## An Efficient Implementation of Sugiyama's Algorithm for
#' ## Layered Graph Drawing, Journal of Graph Algorithms and
#' ## Applications 9, 305--325 (2005).
#'
#' ex <- graph_from_literal( 0 -+ 29: 6: 5:20: 4,
#' 1 -+ 12,
#' 2 -+ 23: 8,
#' 3 -+ 4,
#' 4,
#' 5 -+ 2:10:14:26: 4: 3,
#' 6 -+ 9:29:25:21:13,
#' 7,
#' 8 -+ 20:16,
#' 9 -+ 28: 4,
#' 10 -+ 27,
#' 11 -+ 9:16,
#' 12 -+ 9:19,
#' 13 -+ 20,
#' 14 -+ 10,
#' 15 -+ 16:27,
#' 16 -+ 27,
#' 17 -+ 3,
#' 18 -+ 13,
#' 19 -+ 9,
#' 20 -+ 4,
#' 21 -+ 22,
#' 22 -+ 8: 9,
#' 23 -+ 9:24,
#' 24 -+ 12:15:28,
#' 25 -+ 11,
#' 26 -+ 18,
#' 27 -+ 13:19,
#' 28 -+ 7,
#' 29 -+ 25 )
#'
#' layers <- list( 0, c(5, 17), c(2, 14, 26, 3), c(23, 10, 18), c(1, 24),
#' 12, 6, c(29,21), c(25,22), c(11,8,15), 16, 27, c(13,19),
#' c(9, 20), c(4, 28), 7 )
#'
#' layex <- layout_with_sugiyama(ex, layers=apply(sapply(layers,
#' function(x) V(ex)$name %in% as.character(x)),
#' 1, which))
#'
#' origvert <- c(rep(TRUE, vcount(ex)), rep(FALSE, nrow(layex$layout.dummy)))
#' realedge <- as_edgelist(layex$extd_graph)[,2] <= vcount(ex)
#' plot(layex$extd_graph, vertex.label.cex=0.5,
#' edge.arrow.size=.5,
#' vertex.size=ifelse(origvert, 5, 0),
#' vertex.shape=ifelse(origvert, "square", "none"),
#' vertex.label=ifelse(origvert, V(ex)$name, ""),
#' edge.arrow.mode=ifelse(realedge, 2, 0))
#'
layout_with_sugiyama <- function(graph, layers=NULL, hgap=1, vgap=1,
maxiter=100, weights=NULL,
attributes=c("default", "all", "none")) {
# Argument checks
if (!is_igraph(graph)) { stop("Not a graph object") }
if (!is.null(layers)) layers <- as.numeric(layers)-1
hgap <- as.numeric(hgap)
vgap <- as.numeric(vgap)
maxiter <- as.integer(maxiter)
if (is.null(weights) && "weight" %in% edge_attr_names(graph)) {
weights <- E(graph)$weight
}
if (!is.null(weights) && any(!is.na(weights))) {
weights <- as.numeric(weights)
} else {
weights <- NULL
}
attributes <- igraph.match.arg(attributes)
on.exit(.Call(C_R_igraph_finalizer) )
# Function call
res <- .Call(C_R_igraph_layout_sugiyama, graph, layers, hgap,
vgap, maxiter, weights)
# Flip the y coordinates, more natural this way
res$res[,2] <- max(res$res[,2]) - res$res[,2] + 1
# Separate real and dummy vertices
vc <- vcount(graph)
res$layout <- res$res[seq_len(vc),]
if (nrow(res$res)==vc) {
res$layout.dummy <- matrix(NA_real_, nrow=0, ncol=2)
} else {
res$layout.dummy <- res$res[(vc+1):nrow(res$res),]
}
# Add some attributes to the extended graph
E(res$extd_graph)$orig <- res$extd_to_orig_eids
res$extd_to_orig_eids <- NULL
res$extd_graph <- set_vertex_attr(res$extd_graph, "dummy",
value=c(rep(FALSE, vc),
rep(TRUE, nrow(res$res)-vc)))
res$extd_graph$layout <- rbind(res$layout, res$layout.dummy)
if (attributes=="default" || attributes=="all") {
if ("size" %in% vertex_attr_names(graph)) {
V(res$extd_graph)$size <- 0
V(res$extd_graph)$size[ !V(res$extd_graph)$dummy ] <- V(graph)$size
}
if ("size2" %in% vertex_attr_names(graph)) {
V(res$extd_graph)$size2 <- 0
V(res$extd_graph)$size2[ !V(res$extd_graph)$dummy ] <- V(graph)$size2
}
if ("shape" %in% vertex_attr_names(graph)) {
V(res$extd_graph)$shape <- "none"
V(res$extd_graph)$shape[ !V(res$extd_graph)$dummy ] <- V(graph)$shape
}
if ("label" %in% vertex_attr_names(graph)) {
V(res$extd_graph)$label <- ""
V(res$extd_graph)$label[ !V(res$extd_graph)$dummy ] <- V(graph)$label
}
if ("color" %in% vertex_attr_names(graph)) {
V(res$extd_graph)$color <- head(V(graph)$color, 1)
V(res$extd_graph)$color[ !V(res$extd_graph)$dummy ] <- V(graph)$color
}
eetar <- as_edgelist(res$extd_graph, names=FALSE)[,2]
E(res$extd_graph)$arrow.mode <- 0
if ("arrow.mode" %in% edge_attr_names(graph)) {
E(res$extd_graph)$arrow.mode[ eetar <= vc ] <- E(graph)$arrow.mode
} else {
E(res$extd_graph)$arrow.mode[ eetar <= vc ] <- is_directed(graph) * 2
}
if ("arrow.size" %in% edge_attr_names(graph)) {
E(res$extd_graph)$arrow.size <- 0
E(res$extd_graph)$arrow.size[ eetar <= vc ] <- E(graph)$arrow.size
}
}
if (attributes=="all") {
gatt <- setdiff(graph_attr_names(graph), "layout")
vatt <- setdiff(vertex_attr_names(graph),
c("size", "size2", "shape", "label", "color"))
eatt <- setdiff(edge_attr_names(graph),
c("arrow.mode", "arrow.size"))
for (ga in gatt) {
res$extd_graph <- set_graph_attr(res$extd_graph, ga,
graph_attr(graph, ga))
}
for (va in vatt) {
notdummy <- which(!V(res$extd_graph)$dummy)
res$extd_graph <- set_vertex_attr(res$extd_graph, va,
notdummy,
vertex_attr(graph, va))
}
for (ea in eatt) {
eanew <- edge_attr(graph, ea)[E(res$extd_graph)$orig]
res$extd_graph <- set_edge_attr(res$extd_graph, ea, value=eanew)
}
}
res$res <- NULL
res
}
#' @rdname layout_with_sugiyama
#' @param ... Passed to \code{layout_with_sugiyama}.
#' @export
with_sugiyama <- function(...) layout_spec(layout_with_sugiyama, ...)
## ----------------------------------------------------------------
#' Merging graph layouts
#'
#' Place several graphs on the same layout
#'
#' \code{merge_coords} takes a list of graphs and a list of coordinates and
#' places the graphs in a common layout. The method to use is chosen via the
#' \code{method} parameter, although right now only the \code{dla} method is
#' implemented.
#'
#' The \code{dla} method covers the graph with circles. Then it sorts the
#' graphs based on the number of vertices first and places the largest graph at
#' the center of the layout. Then the other graphs are placed in decreasing
#' order via a DLA (diffision limited aggregation) algorithm: the graph is
#' placed randomly on a circle far away from the center and a random walk is
#' conducted until the graph walks into the larger graphs already placed or
#' walks too far from the center of the layout.
#'
#' The \code{layout_components} function disassembles the graph first into
#' maximal connected components and calls the supplied \code{layout} function
#' for each component separately. Finally it merges the layouts via calling
#' \code{merge_coords}.
#'
#' @aliases layout.merge piecewise.layout
#' @param graphs A list of graph objects.
#' @param layouts A list of two-column matrices.
#' @param method Character constant giving the method to use. Right now only
#' \code{dla} is implemented.
#' @param layout A function object, the layout function to use.
#' @param \dots Additional arguments to pass to the \code{layout} layout
#' function.
#' @return A matrix with two columns and as many lines as the total number of
#' vertices in the graphs.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @seealso \code{\link{plot.igraph}}, \code{\link{tkplot}},
#' \code{\link{layout}}, \code{\link{disjoint_union}}
#' @export
#' @family graph layouts
#' @keywords graphs
#' @examples
#'
#' # create 20 scale-free graphs and place them in a common layout
#' graphs <- lapply(sample(5:20, 20, replace=TRUE),
#' barabasi.game, directed=FALSE)
#' layouts <- lapply(graphs, layout_with_kk)
#' lay <- merge_coords(graphs, layouts)
#' g <- disjoint_union(graphs)
#' \dontrun{plot(g, layout=lay, vertex.size=3, labels=NA, edge.color="black")}
merge_coords <- function(graphs, layouts, method="dla") {
if (!all(sapply(graphs, is_igraph))) {
stop("Not a graph object")
}
if (method == "dla") {
on.exit(.Call(C_R_igraph_finalizer) )
res <- .Call(C_R_igraph_layout_merge_dla,
graphs, layouts)
} else {
stop("Invalid `method'.")
}
res
}
#' Normalize coordinates for plotting graphs
#'
#' Rescale coordinates linearly to be within given bounds.
#'
#' \code{norm_coords} normalizes a layout, it linearly transforms each
#' coordinate separately to fit into the given limits.
#'
#' @aliases layout.norm
#' @param layout A matrix with two or three columns, the layout to normalize.
#' @param xmin,xmax The limits for the first coordinate, if one of them or both
#' are \code{NULL} then no normalization is performed along this direction.
#' @param ymin,ymax The limits for the second coordinate, if one of them or
#' both are \code{NULL} then no normalization is performed along this
#' direction.
#' @param zmin,zmax The limits for the third coordinate, if one of them or both
#' are \code{NULL} then no normalization is performed along this direction.
#' @return A numeric matrix with at the same dimension as \code{layout}.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @export
#' @family graph layouts
#' @keywords graphs
norm_coords <- function(layout, xmin=-1, xmax=1, ymin=-1, ymax=1,
zmin=-1, zmax=1) {
if (!is.matrix(layout)) {
stop("`layout' not a matrix")
}
if (ncol(layout) != 2 && ncol(layout) != 3) {
stop("`layout' should have 2 or three columns")
}
if (!is.null(xmin) && !is.null(xmax)) {
layout[,1] <- .layout.norm.col(layout[,1], xmin, xmax)
}
if (!is.null(ymin) && !is.null(ymax)) {
layout[,2] <- .layout.norm.col(layout[,2], ymin, ymax)
}
if (ncol(layout)==3 && !is.null(zmin) && !is.null(zmax)) {
layout[,3] <- .layout.norm.col(layout[,3], zmin, zmax)
}
layout
}
.layout.norm.col <- function(v, min, max) {
vr <- range(v)
if (vr[1]==vr[2]) {
fac <- 1
} else {
fac <- (max-min)/(vr[2]-vr[1])
}
(v-vr[1]) * fac + min
}
#' @rdname merge_coords
#' @aliases piecewise.layout
#' @param graph The input graph.
#' @export
layout_components <- function(graph, layout=layout_with_kk, ...) {
if (!is_igraph(graph)) {
stop("Not a graph object")
}
V(graph)$id <- seq(vcount(graph))
gl <- decompose(graph)
ll <- lapply(gl, layout, ...)
l <- merge_coords(gl, ll)
l[ unlist(sapply(gl, vertex_attr, "id")), ] <- l[]
l
}
#' Spring layout, this was removed from igraph
#'
#' Now it calls the Fruchterman-Reingold layout, with a warning.
#'
#' @param graph Input graph.
#' @param ... Extra arguments are ignored.
#' @return Layout coordinates, a two column matrix.
#'
#' @export
layout.spring <- function(graph, ...) {
warning("Spring layout was removed, we use Fruchterman-Reingold instead.")
layout_with_fr(graph)
}
#' SVD layout, this was removed from igraph
#'
#' Now it calls the Fruchterman-Reingold layout, with a warning.
#'
#' @param graph Input graph.
#' @param ... Extra arguments are ignored.
#' @return Layout coordinates, a two column matrix.
#'
#' @export
layout.svd <- function(graph, ...) {
warning("SVD layout was removed, we use Fruchterman-Reingold instead.")
layout_with_fr(graph)
}
#' Grid Fruchterman-Reingold layout, this was removed from igraph
#'
#' Now it calls the Fruchterman-Reingold layout, with a warning.
#'
#' @param graph Input graph.
#' @param ... Extra arguments are ignored.
#' @return Layout coordinates, a two column matrix.
#'
#' @export
layout.fruchterman.reingold.grid <- function(graph, ...) {
warning("Grid Fruchterman-Reingold layout was removed,\n",
"we use Fruchterman-Reingold instead.")
layout_with_fr(graph)
}
|