Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frbcesab/chessboard
:package: Create network connections based on chess moves
https://github.com/frbcesab/chessboard
connectivity-matrix directed-networks neighborhood network one-dimensional-networks r-package spatial-networks two-dimensional-networks undirected-networks
Last synced: about 21 hours ago
JSON representation
:package: Create network connections based on chess moves
- Host: GitHub
- URL: https://github.com/frbcesab/chessboard
- Owner: FRBCesab
- License: gpl-2.0
- Created: 2022-07-21T13:03:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-16T10:12:48.000Z (over 1 year ago)
- Last Synced: 2024-04-26T10:20:38.174Z (9 months ago)
- Topics: connectivity-matrix, directed-networks, neighborhood, network, one-dimensional-networks, r-package, spatial-networks, two-dimensional-networks, undirected-networks
- Language: R
- Homepage: https://frbcesab.github.io/chessboard
- Size: 21.6 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%")
```
chessboard 
=========================================================
[](https://CRAN.R-project.org/package=chessboard)
[](https://github.com/frbcesab/chessboard/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/FRBCesab/chessboard)
[](https://github.com/frbcesab/chessboard/actions/workflows/pkgdown.yaml)
[](https://choosealicense.com/licenses/gpl-2.0/)
[](https://joss.theoj.org/papers/10.21105/joss.05753)
## Table of contents
• Overview
• Features
• Installation
• Get started
• Long-form documentations
• Citation
• Contributing
• Acknowledgments
• References
## Overview
The package `chessboard` provides functions to work with **directed**
(asymmetric) and **undirected** (symmetric) spatial (or non-spatial) **networks**.
It implements different methods to detect neighbors, all based on the chess game
(it goes beyond the rook and the queen) to create complex connectivity scenarios.
`chessboard` can handle spatial networks, but it does not explicitly use geographical
coordinates to find neighbors (it is not based on spatial distance).
Instead, it identifies neighbors according to **node labels**
(i.e. the node position on a two-dimension chessboard) and a specific method
(pawn, fool, rook, bishop, knight, queen, wizard, etc.).
It implements the following rules to detect neighbors and create edges:
- the **degree** of neighborhood: the number of adjacent nodes that will be used
to create direct edges.
- the **orientation** of neighborhood: can neighbors be detected horizontally,
vertically and/or diagonally?
- the **direction** of neighborhood: does the sampling has a main direction?
This can be particularly relevant for directed networks (e.g. rivers).
## Features
The main purpose of `chessboard` is to create various network objects, including:
- **node list**
- **edge list**
- **connectivity matrix**
`chessboard` also provides different plotting functions (all based on the [`ggplot2`](https://ggplot2.tidyverse.org/) package):
- [`gg_matrix()`](https://frbcesab.github.io/chessboard/reference/gg_matrix.html)
plots a (connectivity) matrix
- [`gg_chessboard()`](https://frbcesab.github.io/chessboard/reference/gg_chessboard.html)
plots the sampling as a chessboard
Read the [Visualization tools](https://frbcesab.github.io/chessboard/articles/visualization-tools.html)
vignette for further details.
Finally, the package can also produce objects that will be used later in
Moran's Eigenvector Maps
([MEM](https://rdrr.io/cran/adespatial/man/mem.html),
Dray _et al._ 2006) and Asymetric Eigenvector Maps
([AEM](https://rdrr.io/cran/adespatial/man/aem.html),
Blanchet _et al._ 2008), methods available in the package
[`adespatial`](https://cran.r-project.org/package=adespatial) (Dray _et al._ 2023):
- **edges weights matrix**
- **spatial weights matrix**
- **nodes by edges matrix**
- **edges weights vector**
## Installation
You can install the stable version from [CRAN](https://cran.r-project.org/) with:
```{r eval=FALSE}
## Install stable version of < chessboard > from CRAN ----
install.packages("chessboard")
```
Or you can install the development version from [GitHub](https://github.com/) with:
```{r eval=FALSE}
## Install < remotes > package (if not already installed) ----
if (!requireNamespace("remotes", quietly = TRUE)) {
install.packages("remotes")
}
## Install dev version of < chessboard > from GitHub ----
remotes::install_github("FRBCesab/chessboard")
```
Then you can attach the package `chessboard`:
```{r eval=FALSE}
library("chessboard")
```
## Get started
For an overview of the main features of `chessboard`, please read the
[Get started](https://frbcesab.github.io/chessboard/articles/chessboard.html)
vignette.
## Long-form documentations
`chessboard` provides three vignettes to learn more about the package:
- the [Get started](https://frbcesab.github.io/chessboard/articles/chessboard.html)
vignette describes the core features of the package
- the [Chess pieces](https://frbcesab.github.io/chessboard/articles/chess-pieces.html)
vignette details the different methods implemented in `chessboard` to detect
neighbors
- the [Visualization tools](https://frbcesab.github.io/chessboard/articles/visualization-tools.html)
vignette describes the plotting functions available in `chessboard`
## Citation
Please cite `chessboard` as:
> Casajus N, Rievrs Borges E, Tabacchi E, Fried G & Mouquet N (2023) `chessboard`: An R
package for creating network connections based on chess moves.
**_Journal of Open Source Software_**, _8_, 5753. .
## Contributing
All types of contributions are encouraged and valued. For more information,
check out our [Contributor Guidelines](https://github.com/FRBCesab/chessboard/blob/main/CONTRIBUTING.md).
Please note that the `chessboard` project is released with a
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.
## Acknowledgments
This package has been developed for the
[FRB-CESAB](https://www.fondationbiodiversite.fr/en/about-the-foundation/le-cesab/)
working group
[Bridge](https://www.fondationbiodiversite.fr/en/the-frb-in-action/programs-and-projects/le-cesab/bridge/)
that aims to better understand the role of local and regional environmental
factors in shaping the taxonomic and functional diversity of plant communities
established along river corridors, roadside corridors and cultivated field
margins.
## References
Blanchet FG, Legendre P & Borcard D (2008) Modelling directional spatial processes
in ecological data. **Ecological Modelling**, 215, 325-336.
doi: [10.1016/j.ecolmodel.2008.04.001](https://doi.org/10.1016/j.ecolmodel.2008.04.001).
Csardi G & Nepusz T (2006) The igraph software package for complex network research.
**InterJournal, Complex Systems**, 1695, 1-9. .
Dray S, Bauman D, Blanchet G _et al._ (2023) `adespatial`: Multivariate Multiscale Spatial Analysis.
R package version 0.3-21, .
Dray S, Legendre P & Peres-Neto PR (2006) Spatial modeling: a comprehensive
framework for principal coordinate analysis of neighbor matrices (PCNM).
**Ecological Modelling**, 196: 483–93.
doi: [10.1016/j.ecolmodel.2006.02.015](https://doi.org/10.1016/j.ecolmodel.2006.02.015).