Skip to content

Commit

Permalink
add input table from #220 to iso vignette to close #225
Browse files Browse the repository at this point in the history
  • Loading branch information
mpadge committed May 24, 2024
1 parent 91b7960 commit 9ab1e64
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: dodgr
Title: Distances on Directed Graphs
Version: 0.3.0.055
Version: 0.3.0.056
Authors@R: c(
person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre")),
person("Andreas", "Petutschnig", role = "aut"),
Expand Down
2 changes: 1 addition & 1 deletion codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"name": "dodgr: Distances on Directed Graphs",
"codeRepository": "https://github.com/UrbanAnalyst/dodgr",
"issueTracker": "https://github.com/UrbanAnalyst/dodgr/issues",
"version": "0.3.0.055",
"version": "0.3.0.056",
"license": "https://spdx.org/licenses/GPL-3.0",
"programmingLanguage": {
"@type": "ComputerLanguage",
Expand Down
24 changes: 24 additions & 0 deletions vignettes/iso.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,30 @@ or `tlim` for
[`dodgr_isochrones()`](https://UrbanAnalyst.github.io/dodgr/reference/dodgr_isochrones.html)).
The functions are also internally parallelised for efficient calculation.

## Input formats

The [`dodgr_isodists()`](https://UrbanAnalyst.github.io/dodgr/reference/dodgr_isodists.html)
function accepts arbitrary input, either as a generic `dodgr` `data.frame`
(with a "distance" column), or as street networks derived from applying the
[`weight_streetnet()`](https://UrbanAnalyst.github.io/dodgr/reference/weight_streetnet.html)
function to either [`sf`](https://r-spatial.github.io/sf) or
[`st`](https://hypertidy.github.io/silicate) objects. Time-based calculations
in `dodgr` are only possible when applied to street networks dervied from
[`st`](https://hypertidy.github.io/silicate) objects, because equivalent
`sf`-based objects can only provide crude estimates of journey times. The time-specific functions
[`dodgr_isochrones()`](https://UrbanAnalyst.github.io/dodgr/reference/dodgr_isochrones.html)
and
[`dodgr_isoverts()`](https://UrbanAnalyst.github.io/dodgr/reference/dodgr_isoverts.html)
thus only accept `dodgr` street networks derived from `sc` data. The following
table summarises the requirements of these functions:

Function | Input type
--- | ---
dodgr_isodists | Either `sf` or `sc` format data
dodgr_ isochrones | Only `sc` format data
dodgr_isoverts | Only `sc` format data


## dodgr_isodists

The
Expand Down

0 comments on commit 9ab1e64

Please sign in to comment.