DynComm-R-package

Dynamic Network Communities Detection and Generation - R Package

Description

R package that implements several Algorithms used for evolving network analysis regarding community detection, using a common API.

Communities are calculated for the vertices and edges that change over time, without recalculating communities for the entire graph.

Algorithms use different, selectable, Criterion to evaluate the quality increase of the current community mapping.

Post-processing algorithms can be executed over the results to filter them for presentation without changing neither the graph nor the community mapping.

Features

Currently implemented features are:

Features planned to be added:

Known bugs / limitations

Not being fixed in the current version

Project directory structure

The following are the most important files/directories to be aware in the root of the package source code directory:

Software

To be able to use this package, the following software must be installed in your system, in the order presented. Search the web for more details on how to install and configure the software on your operating system, if required.

Installation

The latest version of this package (201901.01.0004) was tested in Xubuntu 20.04 64 bit and Windows 7 Ultimate 64 bit.

You can install the stable version of this package from CRAN, if available, using the following command from within your R console:

install.packages("DynComm")

Otherwise, or to get the latest stable version, you need to compile the source code version provided in the root of the package source code directory.

Additional steps for the source code version

Some additional software and configuration is required to compile and use the source code version of the package.

Package Dependencies

The following packages are required to be installed from within R before trying to compile the source code version of the package. Some packages have dependencies of their own that may need fulfilling.

Compiling the source code version

The safest route is to download the latest stable source code version file from the root of this project and call the following command from within your R console, replacing the “x” by the correct version number:

install.packages("DynComm_xxxxxx.xx.xxxx.tar.gz", repos = NULL, type = "source")

To get the most recent version, which may not be stable nor functional, you can use the source code of the GitHub master version using the following command from within your R console:

devtools::install_github("softskillsgroup/DynComm-R-package/R-CRAN")

If you get errors about paths, directories or files using Staged Installation (the default), you might have to change “StagedInstall: yes” to “StagedInstall: no” in the DESCRIPTION file in order to be able to compile and install locally.

Documentation

Users please check either the manual.pdf file in the project repository or the R help system for the latest version of the manual. Beware that documentation in the R help system might be more up to date. R help can be called using one of the following commands from R console.

help("DyComm-package") or ??"DyComm-package"

Developers please refer to the developer documentation in the R help system using one of the following commands from R console.

help("DyComm-package-dev") or ??"DyComm-package-dev"

Contributing

Please read the CONTRIBUTING file.

License

This project is shared under GNU GPL version 2 or later. Please read the LICENSE file for more details.

Referenced Work

This package uses the following work as reference material for the implementation of the algorithms.