update docs of weight_Streetnet for #190

DESCRIPTION

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

R/weight-streetnet.R

@@ -76,14 +76,18 @@
 #' }
 #'
 #' Restrictions and time-penalties on turns can be implemented from such
-#' objects by setting `turn_penalty = TRUE`. Resultant graphs are fundamentally
-#' different from the default for distance-based routing. The result of
-#' `weight_streetnet(..., turn_penalty = TRUE)` should thus \emph{only} be used
-#' to submit to the \link{dodgr_times} function, and not for any other `dodgr`
-#' functions nor forms of network analysis. Setting `turn_penalty = TRUE` will
+#' objects by setting `turn_penalty = TRUE`. Setting `turn_penalty = TRUE` will
 #' honour turn restrictions specified in Open Street Map (unless the "penalties"
 #' table of \link{weighting_profiles} has `restrictions = FALSE` for a specified
-#' `wt_profile`).
+#' `wt_profile`). Resultant graphs are fundamentally different from the default
+#' for distance-based routing. These graphs may be used directly in the
+#' \link{dodgr_dists} function. Use in any other functions requires additional
+#' information obtained in a file in the temporary directory of the current R
+#' session with a name starting with "dodgr_junctions_", and including the
+#' value of `attr(graph, "hash")`. If graphs with turn penalties are to be used
+#' in subsequent R sessions, this "dodgr_junctions_" file will need to be moved
+#' to a more permanent storage location, and then replaced in the temporary
+#' directory of any subsequent R sessions.
 #'
 #' @note The resultant graph includes only those edges for which the given
 #' weighting profile specifies finite edge weights. Any edges of types not

codemeta.json

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