rcoins

Identify continuous lines in a network using an approach based on the Continuity in Steet Network (COINS) method1.

Installation

You can install the development version of rcoins from the R terminal like so:

# install.packages("devtools")
devtools::install_github("CityRiverSpaces/rcoins")

Alternative installation using conda

An environment including rcoins and all its dependencies can be created using Conda (or its faster implementation Mamba).

Conda can be installed using the Miniforge scripts provided here (download one of the Mambaforge scripts in order to install Mamba as well).

First clone this repository and access it:

git clone https://github.com/CityRiverSpaces/rcoins.git
cd rcoins/

Run conda (or mamba, if using Mambaforge) to create an environment with all the required dependencies:

conda env create -f environment.yml
conda activate rcoins

Install the development version of rcoins:

Rscript -e 'devtools::install()'

Example

This is a basic example which shows you how to solve a common problem:

library(rcoins)
## basic example code

Development

When modifying the R source code, load the library as:

devtools::load_all()

Run tests locally:

devtools::test()

Run the linter locally:

lintr::lint_package()

  1. Tripathy, P., Rao, P., Balakrishnan, K., & Malladi, T. (2021). An open-source tool to extract natural continuity and hierarchy of urban street networks. Environment and Planning B: Urban Analytics and City Science, 48(8), 2188-2205.↩︎