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%"
)
```

# pavement <img src="man/figures/logo.png" align="right" width="138" />

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![CRAN status](https://www.r-pkg.org/badges/version/pavement)](https://CRAN.R-project.org/package=pavement)
[![Codecov test coverage](https://codecov.io/gh/NONONOexe/pavement/branch/main/graph/badge.svg)](https://app.codecov.io/gh/NONONOexe/pavement?branch=main)
<!-- badges: end -->

## Overview

pavement is a package designed to analyze spatial events occurring on roadways. It provides comprehensive toolkit for working with spatial data, empowering users to understand patterns and trends in road-related phenomena.

## Installation

You can install the development version of pavement from [R-universe](https://r-universe.dev) with:

``` r
# Enable the R-universe
options(repos = c(
  nononoexe = "https://nononoexe.r-universe.dev",
  cran = "https://cloud.r-project.org"
))

# Install the package
install.packages("pavement")
```

## Usage

This example demonstrates how to visualize the distribution of roads and traffic accidents using pavement:

```{r example}
library(pavement)

segmented_network <- sample_roads |>
  create_road_network() |>
  set_events(sample_accidents) |>
  create_segmented_network(segment_length = 0.5) |>
  convolute_segmented_network()
plot(segmented_network, mode = "event")
plot(segmented_network, mode = "count")
plot(segmented_network, mode = "density")
```

## Code of conduct

Please note that this project is released with a [Contributor Code of Conduct](https://nononoexe.github.io/pavement/CODE_OF_CONDUCT.html).
By participating in this project you agree to abide by its terms.