-
Notifications
You must be signed in to change notification settings - Fork 28
/
README.Rmd
92 lines (64 loc) · 6.29 KB
/
README.Rmd
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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# ggnetwork
<!-- badges: start -->
[](https://www.tidyverse.org/lifecycle/#maturing)
[](https://github.com/briatte/ggnetwork/releases)
[](https://github.com/briatte/ggnetwork/actions?workflow=R-CMD-check)
[](https://ci.appveyor.com/project/briatte/ggnetwork)
[](https://codecov.io/gh/briatte/ggnetwork)
[](https://cran.r-project.org/package=ggnetwork)
[](https://cran.r-project.org/web/checks/check_results_ggnetwork.html)
[](https://cran.r-project.org/package=ggnetwork)
<!-- badges: end -->
This package allows to pass network objects to [`ggplot2`](https://ggplot2.org/) and provides geometries to plot their elements.
## Get started
You can install the released version of `ggnetwork` [from CRAN](https://cran.r-project.org/package=ggnetwork) with:
``` r
install.packages("ggnetwork")
```
And the development version [from GitHub](https://github.com/briatte/ggnetwork) with:
``` r
# install.packages("remotes")
remotes::install_github("briatte/ggnetwork")
```
The `ggnetwork` package depends on __R 3.5+__ and on `ggplot2` version 2.0.0+.
## Documentation
- The [package vignette](https://briatte.github.io/ggnetwork/) contains detailed examples of how to use its `fortify` method and each of its geometries.
- The [package website](https://briatte.github.io/ggnetwork/articles/ggnetwork.html) has more information and a list of [all package functions](https://briatte.github.io/ggnetwork/reference/index.html).
For further examples that use `ggnetwork` with other packages to produce animated graphs, see James Curley's slides on “[Interactive and Dynamic Network Visualization in R](http://curleylab.psych.columbia.edu/netviz/)” (2016). For even more options, see Katherine Ognyanova's tutorial “[Network visualization with R](https://kateto.net/network-visualization) (2019), and David Schoch's guide “[Network Visualizations in R using `ggraph` and `graphlayouts`](http://mr.schochastics.net/netVizR.html)” (2019).
## Getting help
If you encounter a clear bug, please file a minimal reproducible example [on GitHub](https://github.com/briatte/ggnetwork/issues).
For questions and other discussion, please contact the package maintainer, or ask other users [on Stack Overflow](https://stackoverflow.com/search?tab=newest&q=ggnetwork).
## Citation
You can get a citation for the package from R:
``` r
citation("ggnetwork")
```
## See also
The `ggnetwork` package was written within a larger development effort around network visualization with `ggplot2`, on which you can read the following article:
> Sam Tyner, François Briatte and Heike Hofmann, “[Network Visualization with `ggplot2`](https://doi.org/10.32614/RJ-2017-023),” _The R Journal_ 9(1): 27–59, 2017.
The article also covers the related packages [`geomnet`](https://github.com/sctyner/geomnet) and [`ggnet`](https://github.com/briatte/ggnet). It does not cover the more recent [`ggraph`](https://github.com/thomasp85/ggraph), [`graphlayouts`](https://github.com/schochastics/graphlayouts) and [`tidygraph`](https://github.com/thomasp85/tidygraph), although you should turn to those if you need a highly extensive way to build and plot 'tidy' networks with `ggplot2`.
## Thanks
```{r, include = FALSE, eval = FALSE}
usethis::use_tidy_thanks()
```
Thanks to
[@achmurzy](https://github.com/achmurzy), [@andrewd789](https://github.com/andrewd789), [@ArtemSokolov](https://github.com/ArtemSokolov), [@aterhorst](https://github.com/aterhorst), [@Edouard-Legoupil](https://github.com/Edouard-Legoupil), [@emillykkejensen](https://github.com/emillykkejensen), [@EvanUp](https://github.com/EvanUp), [@evinhas](https://github.com/evinhas), [@ferroao](https://github.com/ferroao), [@FinScience](https://github.com/FinScience), [@ghost](https://github.com/ghost), [@instantkaffee](https://github.com/instantkaffee), [@jalapic](https://github.com/jalapic), [@jcfisher](https://github.com/jcfisher), [@jfaganUK](https://github.com/jfaganUK), [@kippjohnson](https://github.com/kippjohnson), [@koheiw](https://github.com/koheiw), [@komalsrathi](https://github.com/komalsrathi), [@mbojan](https://github.com/mbojan), [@mcanouil](https://github.com/mcanouil), [@mgagliol](https://github.com/mgagliol), [@mhairi](https://github.com/mhairi), [@minimaxir](https://github.com/minimaxir), [@mkarikom](https://github.com/mkarikom), [@nick-youngblut](https://github.com/nick-youngblut), [@pinguinjay](https://github.com/pinguinjay), [@SantiFilippo](https://github.com/SantiFilippo), [@sciabolazza](https://github.com/sciabolazza), [@sctyner](https://github.com/sctyner), [@trinker](https://github.com/trinker), [@zachcp](https://github.com/zachcp) and two anonymous _[R Journal](https://journal.r-project.org/)_ reviewers.
[@heike](https://github.com/heike) and
[@ethen8181](https://github.com/ethen8181) also helped with the tricky issue of having arrows on directed edges, while
[@sumtxt](https://github.com/sumtxt) inspired this package as well as its predecessor, the `ggnet` package, which also benefitted from discussions with
[@pedroj](https://github.com/pedroj) and Bertrand Sudre.
---
Please note that this project is released with a [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.