rsetse

This package is used to calculate the Strain Elevation Tension Spring embedding (SETSe) for networks in R

https://github.com/jonnob/rsetse

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.2%) to scientific vocabulary

Keywords

embedding embedding-graphs graph-embedding igraph networks networkscience r unsupervised-learning
Last synced: 6 months ago · JSON representation

Repository

This package is used to calculate the Strain Elevation Tension Spring embedding (SETSe) for networks in R

Basic Info
Statistics
  • Stars: 7
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
embedding embedding-graphs graph-embedding igraph networks networkscience r unsupervised-learning
Created almost 7 years ago · Last pushed over 3 years ago
Metadata Files
Readme License

README.md

rSETSe

CRAN status R build status Travis build status <!-- badges: end -->

Importnant note

The github version of R setse has been updated so that setseautohd has been re-written in c++ using Rcpp Armadillo. This makes it much faster (between 36 -350 times) than the version on CRAN. If you have larger networks I would definately advise using installing from github not CRAN.

An R package for embedding graphs using the SETSe algorithm

This is the R package for the Strain Elevation Tension Spring embeddings (SETSe) algorithm. SETSe is a deterministic graph embeddings algorithm. It converts the node attributes of a graph into forces and the edge attributes into springs. The algorithm finds an equilibrium position when the forces of the nodes are balanced by the forces on the springs. A full description of the algorithm is given in "The spring bounces back: Introduction to Strain Elevation Tension Spring embedding for network representation" (Bourne 2020). There is a website for the package providing documentation and vignettes at https://jonnob.github.io/rSETSe/index.html . This is a very niche package so please feel free to reach out to me on twitter or through email with questions.

Installation instructions

The package is available on CRAN and can be installed by running install.packages("rsetse").Alternatively it can be installed from github using the below method.

  1. Open R/Rstudio and ensure that devtools has been installed
  2. Run the following code library(devtools); install_github("JonnoB/rSETSe")
  3. Load the package normally using library(rsetse)
  4. All functions have help files e.g ?setse_auto

The package can also be downloaded or cloned then installed locally using the install function from devtools.

Basic use

``` library(rSETSe)

prepares a graph for embedding using SETSe

set.seed(234) #set the random see for generating the network g <- generatepeelsnetwork(type = "E") %>% prepare_edges(k = 500, distance = 1) %>%

prepare the network for a binary embedding

preparecategoricalforce(., nodenames = "name", forcevar = "class")

Embedds using the bi-connected auto-parametrization algorithm.

This method is strongly reccomended, it tends to be much faster and almost always converges

embeddings <- setsebicomp(g, force = "classA", tol = sum(abs(vertexattr(g, "classA")))/1000, hypertol = 0.1, hyperiters = 3000, verbose = T)

```

Cite

To cite rsetse in publications use: Bourne, J. The spring bounces back: introducing the strain elevation tension spring embedding algorithm for network representation. Appl Netw Sci 5, 88 (2020). https://doi.org/10.1007/s41109-020-00329-4

Owner

  • Name: Jonathan Bourne
  • Login: JonnoB
  • Kind: user
  • Location: London
  • Company: @UCL

Mostly, Complex networks and geospatial analysis. Also some FOI stuff

GitHub Events

Total
  • Issue comment event: 4
Last Year
  • Issue comment event: 4

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 112
  • Total Committers: 2
  • Avg Commits per committer: 56.0
  • Development Distribution Score (DDS): 0.009
Top Committers
Name Email Commits
Jonathan Bourne c****g@h****m 111
Jonno J****e@g****m 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 242 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 1
cran.r-project.org: rsetse

Strain Elevation Tension Spring Embedding

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 242 Last month
Rankings
Stargazers count: 22.5%
Forks count: 28.8%
Dependent packages count: 29.8%
Dependent repos count: 35.5%
Average: 38.1%
Downloads: 73.9%
Maintainers (1)
Last synced: 7 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.4.0 depends
  • Matrix * imports
  • Rcpp * imports
  • RcppArmadillo * imports
  • dplyr * imports
  • igraph * imports
  • magrittr * imports
  • methods * imports
  • minpack.lm * imports
  • purrr * imports
  • rlang >= 0.1.2 imports
  • stats * imports
  • tibble * imports
  • ggplot2 * suggests
  • ggraph * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • roxygen2 * suggests
  • tidyr * suggests