rcrisp

Provides tools to automate the morphological delineation of riverside urban areas following the CRiSp (City River Spaces) method.
https://github.com/cityriverspaces/rcrisp

Category: Hydrosphere
Sub Category: Ocean and Hydrology Data Access

Last synced: about 20 hours ago
JSON representation

Repository metadata

Automate the morphological delineation of riverside urban areas.

README.Rmd

          ---
output: github_document
bibliography: vignettes/references.bib
csl: inst/csl/apa.csl
link-citations: true
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

```{r srr-tags, eval=FALSE, echo=FALSE}
#' @srrstats {G1.2} Life cycle badge added in the README and statement on state
#'   of development added in the "Contributing" section.
```

# rcrisp



[![R-CMD-check](https://github.com/CityRiverSpaces/rcrisp/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/CityRiverSpaces/rcrisp/actions/workflows/R-CMD-check.yaml) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15793526.svg)](https://doi.org/10.5281/zenodo.15793526) [![CRAN status](https://www.r-pkg.org/badges/version/rcrisp)](https://CRAN.R-project.org/package=rcrisp) [![](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![name status badge](https://cityriverspaces.r-universe.dev/badges/:name)](https://cityriverspaces.r-universe.dev/) [![Research Software Directory](https://img.shields.io/badge/rsd-rcrisp-00a3e3.svg)](https://research-software-directory.org/software/crisp) [![Rbanism: R package](https://img.shields.io/static/v1?label=Rbanism&message=R%20package&labelColor=93278F&color=00A99D&style=flat-square)](https://github.com/Rbanism) [![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/718_status.svg)](https://github.com/ropensci/software-review/issues/718)


rcrisp provides tools to automate the morphological delineation of riverside urban areas—i.e., the spaces surrounding a river where social, environmental and economic phenomena are assumed to be influenced by the presence of the river—following a method developed in @forgaci2018 [pp. 88-89].

The method is based on the premise that analyses of riverside urban phenomena are often done without a clear and consistent spatial definition of the area of interest and that a morphological delineation—combining the natural terrain of the river valley and the configuration of the overlapping built urban fabric—can provide a more objective and comparable approach. See the [Getting started vignette](https://cityriverspaces.github.io/rcrisp/articles/getting-started.html#why-is-consistent-delineation-important) to understand why consistent delineation matters and how alternative approaches fall short. Delineations following this morphological delineation method enable integrated local analyses, where data from different sources must be combined within a neutral spatial unit, as well as global cross-case analyses, which require a spatial unit that is comparable across different geographic contexts.

The method proposes a hierarchical delineation of four spatial units: the river valley, the river corridor, the corridor segments and the river space. These units are defined based on the combined morphologies of the river valley and urban form. The resulting delineations can be used in any downstream analysis of riverside urban areas that can benefit from consistent and comparable spatial units, including land use, accessibility, and ecosystem services assessments.

The package includes functions to delineate the river valley, the river corridor, the corridor segments, and the river space (i.e., the area between the riverbanks and the first line of buildings) as well as an all-in-one function that runs all desired delineations. The package also includes functions to download and preprocess OpenStreetMap (OSM) and global Digital Elevation Model (DEM) data, which are required as input data for the delineation process.

## Workflow at a glance

1. Define area of interest and parameters for a given city and a river crossing it
2. Get OSM and DEM base layers within the area of interest
3. Run the all-in-one `delineate()` or delineation-specific `delineate_*()` functions to compute valley, corridor, segments, and/or river space
4. Visualize/export results for downstream analysis

See the [Getting started vignette](https://cityriverspaces.github.io/rcrisp/articles/getting-started.html) for further details about the purpose of the package, an end-to-end example, data requirements, and indication of use cases.

## Installation

You can install the released version of rcrisp from [CRAN](https://cran.r-project.org) with:

``` r
install.packages("rcrisp")
```

You can install the development version of rcrisp from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("CityRiverSpaces/rcrisp")
```

## Example

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

```{r example, warning=FALSE, message=FALSE}
library(rcrisp)

# Set location parameters
city_name <- "Bucharest"
river_name <- "Dâmbovița"

# Set AoI parameters for given location
aoi <- define_aoi(city_name, river_name)

# Get data
osm <- get_osm(aoi)
dem <- get_dem(aoi, osm)

# Delineate river corridor with segments
bd <- delineate(aoi, osm, dem, segments = TRUE, riverspace = TRUE)

# Examine delineation object
summary(bd)

# Plot delineation object
plot(bd)
```

## Contributing

rcrisp is in a stable state of development, with some degree of active subsequent development as envisioned by the primary authors.

We also look very much forward to contributions. See the [Contributing Guide](https://github.com/CityRiverSpaces/rcrisp/blob/main/.github/CONTRIBUTING.md) for further details.

This package is released with a [Contributor Code of Conduct](https://github.com/CityRiverSpaces/rcrisp/blob/main/.github/CODE_OF_CONDUCT.md). By contributing to this project you agree to abide by its terms.

## References

        

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: 'rcrisp: Automate the Delineation of Urban River Spaces'
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Claudiu
    family-names: Forgaci
    email: c.forgaci@tudelft.nl
    affiliation: Delft University of Technology
    orcid: 'https://orcid.org/0000-0003-3218-5102'
  - given-names: Francesco
    family-names: Nattino
    email: f.nattino@esciencecenter.nl
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0003-3286-0139'
contributors:
  - given-names: Fakhereh
    family-names: Alidoost
    email: f.alidoost@esciencecenter.nl
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0001-8407-6472'
  - given-names: Meiert Willem
    family-names: Grootes
    email: m.grootes@esciencecenter.nl
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0002-5733-4795'
  - given-names: Yehan
    family-names: Wu
    email: y.wu-13@tudelft.nl
    affiliation: Delft University of Technology
    orcid: 'https://orcid.org/0000-0003-4063-7535'
repository-code: 'https://github.com/CityRiverSpaces/rcrisp'
identifiers:
  - type: doi
    value: 10.5281/zenodo.15793526
abstract: >-
  Automates the process of urban river space delineation
  using the CRiSp (City River Spaces) method.
keywords:
  - urban rivers
  - geospatial data
license: Apache-2.0

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 2 days ago

Total Commits: 1,310
Total Committers: 6
Avg Commits per committer: 218.333
Development Distribution Score (DDS): 0.331

Commits in past year: 102
Committers in past year: 3
Avg Commits per committer in past year: 34.0
Development Distribution Score (DDS) in past year: 0.235

Name Email Commits
Claudiu Forgaci c****i@g****m 877
Francesco Nattino f****o@e****l 330
SarahAlidoost f****t@e****l 58
Meiert Willem Grootes 4****s 33
Meiert Grootes m****s@M****l 9
yehanwu 7****u 3

Committer domains:


Issue and Pull Request metadata

Last synced: 4 days ago

Total issues: 96
Total pull requests: 108
Average time to close issues: 3 months
Average time to close pull requests: 23 days
Total issue authors: 2
Total pull request authors: 3
Average comments per issue: 0.98
Average comments per pull request: 0.61
Merged pull request: 77
Bot issues: 0
Bot pull requests: 0

Past year issues: 48
Past year pull requests: 58
Past year average time to close issues: about 2 months
Past year average time to close pull requests: 27 days
Past year issue authors: 2
Past year pull request authors: 3
Past year average comments per issue: 0.94
Past year average comments per pull request: 0.79
Past year merged pull request: 49
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/cityriverspaces/rcrisp

Top Issue Authors

  • cforgaci (92)
  • fnattino (4)

Top Pull Request Authors

  • cforgaci (88)
  • fnattino (16)
  • yehanwu (4)

Top Issue Labels

  • review (36)
  • documentation (31)
  • enhancement (21)
  • testing (20)
  • bug (7)
  • invalid (6)
  • data (5)
  • good first issue (4)
  • refactor (3)
  • rOpenSci review (2)
  • use case (2)
  • release (1)
  • CI (1)
  • dissemination (1)

Top Pull Request Labels

  • rOpenSci review (19)
  • documentation (11)
  • testing (3)
  • enhancement (1)
  • release (1)

Package metadata

cran.r-project.org: rcrisp

Automate the Delineation of Urban River Spaces

  • Homepage: https://cityriverspaces.github.io/rcrisp/
  • Documentation: http://cran.r-project.org/web/packages/rcrisp/rcrisp.pdf
  • Licenses: Apache License (≥ 2)
  • Latest release: 0.3.1 (published 9 months ago)
  • Last Synced: 2026-08-12T13:05:36.962Z (2 days ago)
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 203 Last month
  • Rankings:
    • Dependent packages count: 26.132%
    • Dependent repos count: 32.174%
    • Average: 48.245%
    • Downloads: 86.43%
  • Maintainers (1)

Dependencies

.github/workflows/pkgcheck.yaml actions
  • ropensci-review-tools/pkgcheck-action main composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.5.0 composite
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/lint.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pr-commands.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/pr-fetch v2 composite
  • r-lib/actions/pr-push v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • R >= 4.1.0 depends
  • checkmate * imports
  • dbscan * imports
  • dplyr * imports
  • lwgeom * imports
  • osmdata * imports
  • rcoins * imports
  • rlang * imports
  • rstac * imports
  • sf >= 0.9.0 imports
  • sfheaders * imports
  • sfnetworks * imports
  • stringr * imports
  • terra * imports
  • tidygraph * imports
  • units * imports
  • visor * imports
  • knitr * suggests
  • purrr * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests
  • withr * suggests

Score: 10.871079578765833