diff --git a/DESCRIPTION b/DESCRIPTION index 286cda74..39a05579 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: dodgr Title: Distances on Directed Graphs -Version: 0.4.1.038 +Version: 0.4.1.039 Authors@R: c( person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre")), person("Andreas", "Petutschnig", role = "aut"), diff --git a/R/flows.R b/R/flows.R index ecf82964..a22eb87c 100644 --- a/R/flows.R +++ b/R/flows.R @@ -1,7 +1,16 @@ #' Aggregate flows throughout a network. #' #' Aggregate flows throughout a network based on an input matrix of flows -#' between all pairs of `from` and `to` points. +#' between all pairs of `from` and `to` points. Flows are calculated by default +#' on contracted graphs, via the `contract = TRUE` parameter. (These are +#' derived by reducing the input graph down to junction vertices only, by +#' joining all intermediate edges between each junction.) If changes to the +#' input graph do not prompt changes to resultant flows, and the default +#' `contract = TRUE` is used, it may be that calculations are using previously +#' cached versions of the contracted graph. If so, please use either +#' \link{clear_dodgr_cache} to remove the cached version, or +#' \link{dodgr_cache_off} prior to initial graph construction to switch the +#' cache off completely. #' #' @param graph `data.frame` or equivalent object representing the network #' graph (see Details) @@ -240,7 +249,15 @@ dodgr_flows_aggregate <- function (graph, #' Aggregate flows dispersed from each point in a network. #' #' Disperse flows throughout a network based on a input vectors of origin points -#' and associated densities +#' and associated densities. Flows are calculated by default on contracted +#' graphs, via the `contract = TRUE` parameter. (These are derived by reducing +#' the input graph down to junction vertices only, by joining all intermediate +#' edges between each junction.) If changes to the input graph do not prompt +#' changes to resultant flows, and the default `contract = TRUE` is used, it +#' may be that calculations are using previously cached versions of the +#' contracted graph. If so, please use either \link{clear_dodgr_cache} to +#' remove the cached version, or \link{dodgr_cache_off} prior to initial graph +#' construction to switch the cache off completely. #' #' @inheritParams dodgr_flows_aggregate #' @param graph `data.frame` or equivalent object representing the network @@ -380,7 +397,15 @@ dodgr_flows_disperse <- function (graph, #' #' Aggregate flows throughout a network using an exponential Spatial Interaction #' (SI) model between a specified set of origin and destination points, and -#' associated vectors of densities. +#' associated vectors of densities. Flows are calculated by default on +#' contracted graphs, via the `contract = TRUE` parameter. (These are derived +#' by reducing the input graph down to junction vertices only, by joining all +#' intermediate edges between each junction.) If changes to the input graph do +#' not prompt changes to resultant flows, and the default `contract = TRUE` is +#' used, it may be that calculations are using previously cached versions of +#' the contracted graph. If so, please use either \link{clear_dodgr_cache} to +#' remove the cached version, or \link{dodgr_cache_off} prior to initial graph +#' construction to switch the cache off completely. #' #' @inheritParams dodgr_flows_aggregate #' @param k Width of exponential spatial interaction function (exp (-d / k)), diff --git a/codemeta.json b/codemeta.json index 1fa6ef3c..fc8f65c8 100644 --- a/codemeta.json +++ b/codemeta.json @@ -11,7 +11,7 @@ "codeRepository": "https://github.com/UrbanAnalyst/dodgr", "issueTracker": "https://github.com/UrbanAnalyst/dodgr/issues", "license": "https://spdx.org/licenses/GPL-3.0", - "version": "0.4.1.038", + "version": "0.4.1.039", "programmingLanguage": { "@type": "ComputerLanguage", "name": "R", diff --git a/man/dodgr_flows_aggregate.Rd b/man/dodgr_flows_aggregate.Rd index c4d28346..a56eb6ac 100644 --- a/man/dodgr_flows_aggregate.Rd +++ b/man/dodgr_flows_aggregate.Rd @@ -76,7 +76,16 @@ Modified version of graph with additional \code{flow} column added. } \description{ Aggregate flows throughout a network based on an input matrix of flows -between all pairs of \code{from} and \code{to} points. +between all pairs of \code{from} and \code{to} points. Flows are calculated by default +on contracted graphs, via the \code{contract = TRUE} parameter. (These are +derived by reducing the input graph down to junction vertices only, by +joining all intermediate edges between each junction.) If changes to the +input graph do not prompt changes to resultant flows, and the default +\code{contract = TRUE} is used, it may be that calculations are using previously +cached versions of the contracted graph. If so, please use either +\link{clear_dodgr_cache} to remove the cached version, or +\link{dodgr_cache_off} prior to initial graph construction to switch the +cache off completely. } \note{ Spatial Interaction models are often fitted through trialling a range diff --git a/man/dodgr_flows_disperse.Rd b/man/dodgr_flows_disperse.Rd index cc968e0e..dbd9b01c 100644 --- a/man/dodgr_flows_disperse.Rd +++ b/man/dodgr_flows_disperse.Rd @@ -51,7 +51,15 @@ Modified version of graph with additional \code{flow} column added. } \description{ Disperse flows throughout a network based on a input vectors of origin points -and associated densities +and associated densities. Flows are calculated by default on contracted +graphs, via the \code{contract = TRUE} parameter. (These are derived by reducing +the input graph down to junction vertices only, by joining all intermediate +edges between each junction.) If changes to the input graph do not prompt +changes to resultant flows, and the default \code{contract = TRUE} is used, it +may be that calculations are using previously cached versions of the +contracted graph. If so, please use either \link{clear_dodgr_cache} to +remove the cached version, or \link{dodgr_cache_off} prior to initial graph +construction to switch the cache off completely. } \note{ Spatial Interaction models are often fitted through trialling a range diff --git a/man/dodgr_flows_si.Rd b/man/dodgr_flows_si.Rd index cd13761e..bc4bd0b1 100644 --- a/man/dodgr_flows_si.Rd +++ b/man/dodgr_flows_si.Rd @@ -79,7 +79,15 @@ Modified version of graph with additional \code{flow} column added. \description{ Aggregate flows throughout a network using an exponential Spatial Interaction (SI) model between a specified set of origin and destination points, and -associated vectors of densities. +associated vectors of densities. Flows are calculated by default on +contracted graphs, via the \code{contract = TRUE} parameter. (These are derived +by reducing the input graph down to junction vertices only, by joining all +intermediate edges between each junction.) If changes to the input graph do +not prompt changes to resultant flows, and the default \code{contract = TRUE} is +used, it may be that calculations are using previously cached versions of +the contracted graph. If so, please use either \link{clear_dodgr_cache} to +remove the cached version, or \link{dodgr_cache_off} prior to initial graph +construction to switch the cache off completely. } \note{ Spatial Interaction models are often fitted through trialling a range