Calculate the travel time from a set of points over a friction surface.
Arguments
- friction_surface
A
SpatRasterfriction surface layer in resistance units. See Details.- points
A two-column
matrix,data.frame, (includingtibbletypes) with longitude (x) in the first column and latitude (y) in the second, or aSpatVector, in the same coordinate reference system asfriction_surface. Points that fall outsidefriction_surfaceare dropped with a warning; if none fall within it, an error is raised.- filename
character. Output file name with extension suitable forterra::writeRaster. IfNULL(default), output will be returned in memory- overwrite
logical. IfTRUEfilenameis overwritten. IfFALSE(default) andfilenamealready exists, the existing file is returned with a warning and no calculation is performed.
Value
A SpatRaster of travel time (in the time units of
friction_surface, e.g. minutes) from each cell to the nearest of
points, with a single layer named "travel_time". Cells that cannot
be reached from any of points (e.g. because they are separated from
them by NA cells in friction_surface) are NA.
Details
Implements methods from Weiss et al. 2018, 2020 to calculate travel time from given locations over a friction surface.
Over large areas this function can require significant RAM and will be slow.
Pre-prepared walking or motorised friction surfaces can be obtained
with get_friction_surface(). Users can also provide their own friction
surface. This surface must be in resistance units (1/conductance), e.g.
minutes/meter. See Van Etten 2017.
Note on this implementation: as of package version 1. Earlier versions of
this package used the raster and gdistance packages. These
dependencies have been removed and now instead rely exclusively on terra
for spatial data handling. The two approaches use the same cost model
(eight-direction movement, edge cost distance * mean(friction)) and
produce effectively the same result. terra::costDist() computes true
geodesic inter-cell distances, so the new approach is more accurate than
the old gdistance's distance approximation away from the equator (the
results are identical at the equator and for projected coordinate systems).
The remaining difference is a boundary convention at the origins:
gdistance includes half of the starting cell's own friction when leaving
a point, whereas terra::costDist measures cost to the border of the
origin cells and omits it. This appears as a small, near-constant offset
(about half a cell of friction) close to the origin points. See the
validation article
https://idem-lab.github.io/traveltime/articles/costdist-validation.html
for the full comparison.
Citations:
D. J. Weiss, A. Nelson, C. A. Vargas-Ruiz, K. Gligoric, S., Bavadekar, E. Gabrilovich, A. Bertozzi-Villa, J. Rozier, H. S. Gibson, T., Shekel, C. Kamath, A. Lieber, K. Schulman, Y. Shao, V. Qarkaxhija, A. K. Nandi, S. H. Keddie, S. Rumisha, P. Amratia, R. Arambepola, E. G. Chestnutt, J. J. Millar, T. L. Symons, E. Cameron, K. E. Battle, S. Bhatt, and P. W. Gething. Global maps of travel time to healthcare facilities. (2020) Nature Medicine. doi:10.1038/s41591-020-1059-1
D. J. Weiss, A. Nelson, H.S. Gibson, W. Temperley, S. Peedell, A. Lieber, M. Hancher, E. Poyart, S. Belchior, N. Fullman, B. Mappin, U. Dalrymple, J. Rozier, T.C.D. Lucas, R.E. Howes, L.S. Tusting, S.Y. Kang, E. Cameron, D. Bisanzio, K.E. Battle, S. Bhatt, and P.W. Gething. A global map of travel time to cities to assess inequalities in accessibility in 2015. (2018). Nature. doi:10.1038/nature25181
van Etten, J. (2017). R package gdistance: Distances and routes on geographical grids. Journal of Statistical Software doi:10.18637/jss.v076.i13
Examples
# a small synthetic friction surface (minutes per metre), so this example
# runs without an internet connection
friction_surface <- terra::rast(
nrows = 50,
ncols = 50,
xmin = 111,
xmax = 112,
ymin = 0,
ymax = 1,
crs = "EPSG:4326",
vals = 0.01
)
from_here <- data.frame(
x = c(111.2, 111.9),
y = c(0.2, 0.35)
)
calculate_travel_time(
friction_surface = friction_surface,
points = from_here
)
#> class : SpatRaster
#> size : 50, 50, 1 (nrow, ncol, nlyr)
#> resolution : 0.02, 0.02 (x, y)
#> extent : 111, 112, 0, 1 (xmin, xmax, ymin, ymax)
#> coord. ref. : lon/lat WGS 84 (EPSG:4326)
#> source(s) : memory
#> name : travel_time
#> min value : 0
#> max value : 961.545835
# \donttest{
# a real motorised friction surface, downloaded from the Malaria Atlas
# Project (requires an internet connection)
motor_surface <- get_friction_surface(
surface = "motor2020",
extent = c(111, 112, 0, 1)
)
#> Registered S3 methods overwritten by 'malariaAtlas':
#> method from
#> autoplot.SpatRaster tidyterra
#> autoplot.default ggplot2
#> Checking if the following Surface-Year combinations are available to download:
#>
#> DATASET ID YEAR
#> - Accessibility__202001_Global_Motorized_Friction_Surface: DEFAULT
#>
#> Loading required package: sf
#> Linking to GEOS 3.12.1, GDAL 3.8.4, PROJ 9.4.0; sf_use_s2() is FALSE
#> No encoding supplied: defaulting to UTF-8.
#> <GMLEnvelope>
#> ....|-- lowerCorner: 0 111
#> ....|-- upperCorner: 1 112
if (!is.null(motor_surface)) {
calculate_travel_time(
friction_surface = motor_surface,
points = from_here
)
}
#> class : SpatRaster
#> size : 120, 120, 1 (nrow, ncol, nlyr)
#> resolution : 0.008333333, 0.008333333 (x, y)
#> extent : 111, 112, 3.774758e-15, 1 (xmin, xmax, ymin, ymax)
#> coord. ref. : lon/lat WGS 84 (EPSG:4326)
#> source(s) : memory
#> varname : Accessibility__202001_Global_Motorized_Friction_Surface_0,111,1,112
#> name : travel_time
#> min value : 0
#> max value : 565.122007
# }