install_infomap: A wrapper to install Infomap's standalone file.

In Ecological-Complexity-Lab/infomap_ecology_package: Community Detection using Infomap, Inspired by Ecological Networks

A wrapper to install Infomap's standalone file.

Description

Downloads the latest binary release version from MapEquation according to the machine's operating system (Windows/MacOS/Linux). Unix based OS users have the option to download the latest version in development from the git. In that case it clones the GitHub repository and runs make via R's system command. This is merely a wrapper for commands that can be easily run in the terminal.

Usage

install_infomap(target_folder = NULL, source = "binary", version = "2.7.1")

Arguments

target_folder	Where to install Infomap. Defaults to R's current working directory (getwd()). Note: avoid using special characters or spaces in the folder's path.
source	The source to download Infomap from. Relevant only for Unix based operating systems. "git" to download the latest version from development, "binary" (default) to download the latest release version.
version	The version of Infomap to install. By default, it installs version 2.7.1. Users are encouraged to check for the latest version.

Details

Users have the option to download the specific version by providing the argument version If version is not provided, it installs version 2.7.1.

For now, this package depends on Infomap's stand-alone version. Future versions or another package will incorporate Infomap directly into R. Therefore it is necessary to install infomap in the same folder where the code is Run. If it is already installed, then it will be replaced. Check for a list of versions For full instructions see here

Value

FALSE and an error if Infomap is not installed correctly. TRUE (and version number) if it is.

Examples

## Not run: 
install_infomap()

## End(Not run)

Ecological-Complexity-Lab/infomap_ecology_package documentation built on June 6, 2024, 5:28 a.m.