update docs for input graph param types; closes #220

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: dodgr
 Title: Distances on Directed Graphs
-Version: 0.3.0.022
+Version: 0.3.0.023
 Authors@R: c(
     person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre")),
     person("Andreas", "Petutschnig", role = "aut"),

R/dists.R

@@ -1,7 +1,9 @@
 #' Calculate matrix of pair-wise distances between points.
 #'
 #' @param graph `data.frame` or equivalent object representing the network
-#' graph (see Notes)
+#' graph (see Notes). For `dodgr` street networks, this may be a network derived
+#' from either \pkg{sf} or \pkg{silicate} ("sc") data, generated with
+#' \link{weight_streetnet}.
 #' @param from Vector or matrix of points **from** which route distances are to
 #' be calculated (see Notes)
 #' @param to Vector or matrix of points **to** which route distances are to be

R/iso.R

@@ -4,7 +4,9 @@
 #' and vectors defining multiple isodistances.
 #'
 #' @param graph `data.frame` or equivalent object representing the network
-#' graph (see Notes)
+#' graph. For `dodgr` street networks, this may be a network derived from either
+#' \pkg{sf} or \pkg{silicate} ("sc") data, generated with
+#' \link{weight_streetnet}.
 #' @param from Vector or matrix of points **from** which isodistances are to
 #' be calculated.
 #' @param dlim Vector of desired limits of isodistances in metres.
@@ -128,6 +130,10 @@ iso_pre <- function (graph, from = NULL, heap = "BHeap", contract = TRUE) {
 #'
 #' @inherit dodgr_isodists
 #'
+#' @param graph `data.frame` or equivalent object representing the network
+#' graph. For `dodgr` street networks, this must be a network derived from
+#' \pkg{silicate} ("sc") data, generated with \link{weight_streetnet}. This
+#' function does not work with networks derived from \pkg{sf} data.
 #' @param from Vector or matrix of points **from** which isochrones are to
 #' be calculated.
 #' @param tlim Vector of desired limits of isochrones in seconds
@@ -185,6 +191,10 @@ dodgr_isochrones <- function (graph,
 #'
 #' @inheritParams dodgr_isodists
 #'
+#' @param graph `data.frame` or equivalent object representing the network
+#' graph. For `dodgr` street networks, this must be a network derived from
+#' \pkg{silicate} ("sc") data, generated with \link{weight_streetnet}. This
+#' function does not work with networks derived from \pkg{sf} data.
 #' @param from Vector or matrix of points **from** which isodistances or
 #' isochrones are to be calculated.
 #' @param tlim Vector of desired limits of isochrones in seconds

R/times.R

@@ -1,9 +1,13 @@
 #' Calculate matrix of pair-wise travel times between points.
 #'
 #' @inherit dodgr_dists
-#' @param graph A `dodgr` network returned from the \link{weight_streetnet}
-#' function using a network obtained with the \pkg{osmdata} `osmdata_sc`
-#' function, possibly contracted with \link{dodgr_contract_graph}.
+#' @param graph `data.frame` or equivalent object representing the network
+#' graph (see Notes). For `dodgr` street networks, this may be a network derived
+#' from either \pkg{sf} or \pkg{silicate} ("sc") data, generated with
+#' \link{weight_streetnet}. Note, however, that networks derived from \pkg{sf}
+#' data will generally not produce reliable estimates of times. Accurate
+#' estimates can only be guaranteed by using networks derived from
+#' \pkg{silicate} ("sc") data.
 #' @param shortest If `TRUE`, calculate times along the \emph{shortest} rather
 #' than fastest paths.
 #'

codemeta.json

@@ -7,7 +7,7 @@
   "codeRepository": "https://github.com/UrbanAnalyst/dodgr",
   "issueTracker": "https://github.com/UrbanAnalyst/dodgr/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "0.3.0.022",
+  "version": "0.3.0.023",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",