Data

Tools

Indexes

Applications

Experiments

Open Source Science

roads

Road network simulation methods

https://github.com/landscitech/roads

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.7%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Road network simulation methods

Basic Info
Statistics
  • Stars: 5
  • Watchers: 5
  • Forks: 2
  • Open Issues: 1
  • Releases: 4
Created over 7 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License

README.Rmd 

---
output: github_document
editor_options: 
  markdown: 
    wrap: 72
---



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

# roads 




[![CRAN status](https://www.r-pkg.org/badges/version/roads)](https://CRAN.R-project.org/package=roads)
[![R-CMD-check](https://github.com/LandSciTech/roads/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/LandSciTech/roads/actions/workflows/R-CMD-check.yaml)


The roads package offers iterative least cost path and minimum spanning tree methods for projecting forest road networks. The methods connect a set of target points to an existing road network using igraph  to identify least cost routes. The cost of constructing a road segment between adjacent pixels is determined by a user supplied `weightRaster` and a `weightFunction`; options include the average of adjacent `weightRaster` values, and a function of the elevation differences between adjacent cells that penalizes steep grades. These road network projection methods are intended for integration into R workflows and modelling frameworks used for forecasting forest change, and can be applied over multiple timesteps without rebuilding a graph at each timestep.

## Installation

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

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

And the development version from
[GitHub](https://github.com/LandSciTech/roads) with:

``` r
# install.packages("devtools")
devtools::install_github("LandSciTech/roads")
```

## Example

To simulate the development of roads three inputs are needed: the current road
network, the locations that should be connected to the road network (landings),
and a weights raster that together with the weighting function determines the
cost to connect two raster cells with a road. Typically the roads and landings
are `sf` objects or `sp` Spatial\* objects and the weight is a raster.

```{r example, message=FALSE}
library(roads)
library(raster)

# data set installed with roads package
demoScen <- prepExData(demoScen)
scen <- demoScen[[1]]

prRoads <- projectRoads(landings = scen$landings.points, 
                        weightRaster = scen$cost.rast,
                        roads = scen$road.line, 
                        plotRoads = TRUE) 

```

By default `projectRoads` uses an iterative least cost paths algorithm
(`roadMethod = "ilcp"`) to connect each landing to the existing road by the
lowest cost path, updating the cost after each landing is connected. A minimum spanning tree method (`roadMethod
= "mst"`) is also available.

For more details see `vignette("roads-vignette", package = "roads")`

# License

Copyright (C) 2021 Her Majesty the Queen in Right of Canada, as
represented by the Minister of Environment and Climate Change.

And 

Copyright 2018 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at



Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Owner

  • Name: Landscape Science & Technology Division, Environment & Climate Change Canada
  • Login: LandSciTech
  • Kind: organization
  • Location: National Wildlife Research Centre, Carleton University, Ottawa, ON

GitHub Events

Total
  • Watch event: 1
  • Push event: 2
Last Year
  • Watch event: 1
  • Push event: 2

Committers

Last synced: over 3 years ago

All Time
  • Total Commits: 328
  • Total Committers: 6
  • Avg Commits per committer: 54.667
  • Development Distribution Score (DDS): 0.357
Top Committers
Name Email Commits
see24 s****4@g****m 211
kirbygeo p****o@g****m 59
Josie Hughes j****s@c****a 33
Hughes J****s@e****a 16
Josie Hughes j****s@g****m 8
Sarah Endicott 3****4@u****m 1
Committer Domains (Top 20 + Academic)
ec.gc.ca: 1 canada.ca: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 29
  • Total pull requests: 5
  • Average time to close issues: 8 months
  • Average time to close pull requests: 27 days
  • Total issue authors: 3
  • Total pull request authors: 1
  • Average comments per issue: 2.38
  • Average comments per pull request: 0.2
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • see24 (24)
  • josie-hughes (4)
  • rhijmans (1)
Pull Request Authors
  • see24 (5)
Top Labels
Issue Labels
question (3) enhancement (2)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 255 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 1
cran.r-project.org: roads

Road Network Projection

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 255 Last month
Rankings
Forks count: 21.9%
Stargazers count: 26.2%
Dependent packages count: 29.8%
Average: 32.4%
Dependent repos count: 35.5%
Downloads: 48.5%
Maintainers (1)
sarah.endicott@ec.gc.ca
Last synced: 11 months ago

Dependencies

DESCRIPTION cran
  • R >= 2.10 depends
  • SpaDES.tools * imports
  • data.table * imports
  • dplyr * imports
  • igraph * imports
  • methods * imports
  • raster * imports
  • rlang * imports
  • sf * imports
  • sp * imports
  • stars * imports
  • terra * imports
  • tidyselect * imports
  • units * imports
  • knitr * suggests
  • rmarkdown * suggests
  • testthat >= 2.1.0 suggests
  • viridis * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite