README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

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

# CRiSp

<!-- badges: start -->
[![R-CMD-check](https://github.com/CityRiverSpaces/CRiSp/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/CityRiverSpaces/CRiSp/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

CRiSp (City River Spaces) provides tools to automate the morphological delineation of riverside urban areas.

## Installation

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

``` r
# install.packages("devtools")
devtools::install_github("CityRiverSpaces/CRiSp")
```

## Example

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

```{r example}
library(CRiSp)

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

# Get base layer for plotting
bucharest_bb <- get_osm_bb(city_name)
bucharest_streets <- get_osm_streets(bucharest_bb, epsg_code)[, "geometry"]

# Delineate river corridor
bucharest_river <- delineate_corridor("Bucharest", "Dâmbovița", crs = epsg_code)

# Plot results
plot(bucharest_river, border = "orange", lwd = 3)
plot(bucharest_streets, add = TRUE)
```

## Contributing

We look very much forward to contributions to the package. See the [Contributing Guide](.github/CONTRIBUTING.md) for further details.

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