# Sustainable Transport Planning

## Documentation for package ‘stplanr’ version 0.2.3

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Code demos. Use demo() to run them.

## Help Pages

A B C D F G I L M N O P Q R S T U V W Z

stplanr-package | *stplanr: Sustainable Transport Planning with R*

## -- A --

angle_diff | Calculate the angular difference between lines and a predefined bearing
as_sf_fun | Convert functions support sf/sp
as_sp_fun | Convert functions support sf/sp

## -- B --

bb2poly | Flexible function to generate bounding boxes
bbox_scale | Scale a bounding box
buff_geo | Create a buffer of n metres for non-projected 'geographical' spatial data

## -- C --

calc_catchment | Calculate catchment area and associated summary statistics.
calc_catchment_sum | Calculate summary statistics for catchment area.
calc_moving_catchment | Calculate summary statistics for all features independently.
calc_network_catchment | Calculate catchment area and associated summary statistics using network.
ca_local | SpatialPointsDataFrame representing road traffic deaths
cents | Spatial points representing home locations
cents_sf | Spatial points representing home locations
crs_select_aeq | Select a custom projected CRS for the area of interest

## -- D --

decode_gl | Decode Google polyline compressed string
destinations | example destinations data
destinations_sf | example destinations data
destination_zones | example destinations data
dist_google | Return travel network distances and time using the Google Maps API
dl_stats19 | Download Stats19 data

## -- F --

find_network_nodes | Find graph node ID of closest node to given coordinates
flow | data frame of commuter flows
flowlines | spatial lines dataset of commuter flows
flowlines_sf | spatial lines dataset of commuter flows
flow_dests | data frame of invented commuter flows with destinations in a different layer than the origins
format_stats19_ac | Format UK 'Stats19' road traffic casualty data
format_stats19_ca | Format UK 'Stats19' road traffic casualty data
format_stats19_ve | Format UK 'Stats19' road traffic casualty data

## -- G --

gclip | Crops spatial object x to the bounding box of spatial object (or matrix) b
geo_bb | Flexible function to generate bounding boxes
geo_bb_matrix | Create matrix representing the spatial bounds of an object
geo_buffer | Perform a buffer operation on a temporary projected CRS
geo_code | Convert text strings into points on the map
geo_projected | Perform GIS functions on a temporary, projected version of a spatial object
geo_select_aeq | Select a custom projected CRS for the area of interest
geo_toptail | Clip the first and last n metres of SpatialLines
gprojected | Perform GIS functions on a temporary, projected version of a spatial object
gsection | Function to split overlapping SpatialLines into segments
gtfs2sldf | Import GTFS shapes and route data to SpatialLinesDataFrame.

## -- I --

islines | Do the intersections between two geometries create lines?
is_linepoint | Identify lines that are points

## -- L --

line2df | Convert SpatialLinesDataFrame objects to a data.frame with from and to coords
line2points | Convert a SpatialLinesDataFrame to points The number of points will be double the number of lines with 'line2points'. A closely related function, 'line2pointsn' returns all the points that were line vertices. The points corresponding with a given line, 'i', will be '(2*i):((2*i)+1)'.
line2pointsn | Convert a SpatialLinesDataFrame to points The number of points will be double the number of lines with 'line2points'. A closely related function, 'line2pointsn' returns all the points that were line vertices. The points corresponding with a given line, 'i', will be '(2*i):((2*i)+1)'.
line2route | Convert straight OD data (desire lines) into routes
line2routeRetry | Convert straight SpatialLinesDataFrame from flow data into routes retrying on connection (or other) intermittent failures
lineLabels | Label SpatialLinesDataFrame objects
line_bearing | Find the bearing of straight lines
line_length | Calculate length of lines in geographic CRS
line_match | Match two sets of lines based on similarity
line_midpoint | Find the mid-point of lines
line_sample | Sample n points along lines with density proportional to a weight
line_segment | Divide SpatialLines dataset into regular segments
line_to_points | Convert a SpatialLinesDataFrame to points The number of points will be double the number of lines with 'line2points'. A closely related function, 'line2pointsn' returns all the points that were line vertices. The points corresponding with a given line, 'i', will be '(2*i):((2*i)+1)'.
locate2spdf | Return SpatialPointsDataFrame with located points from OSRM locate service
l_poly | Line polygon

## -- M --

mapshape | Simplify geometry of spatial objects with the mapshaper library
mapshape_available | Does the computer have mapshaper available?

## -- N --

nearest2spdf | Return SpatialPointsDataFrame with nearest street from OSRM nearest service
nearest_cyclestreets | Generate nearest point on the route network of a point using the CycleStreets.net
nearest_google | Generate nearest point on the route network of a point using the Google Maps API
nearest_osm | Generate nearest point on the route network of a point from OSRM locate service
n_sample_length | Sample integer number from given continuous vector of line lengths and probabilities, with total n
n_vertices | Retrieve the number of vertices from a SpatialLines or SpatialPolygons object

## -- O --

od2line | Convert flow data to SpatialLinesDataFrame
od2line2 | Convert flow data to SpatialLinesDataFrame
od2odf | Extract coordinates from OD data
od_aggregate | Aggregate OD data between polygon geometries
od_coords | General function to create a matrix representing origins and destinations
od_dist | Quickly calculate Euclidean distances of od pairs
od_id_order | Generate ordered ids of OD pairs so lowest is always first
od_radiation | Function that estimates flow between points or zones using the radiation model
onewaygeo | Aggregate flows so they become non-directional (by geometry - the slow way)
onewayid | Aggregate ods so they become non-directional
onewayid.data.frame | Aggregate ods so they become non-directional
onewayid.SpatialLines | Aggregate ods so they become non-directional
overline | Convert series of overlapping lines into a route network

## -- P --

plot-method | Plot a SpatialLinesNetwork
plot-method | Plot an sfNetwork
points2flow | Convert a series of points into geographical flows
points2line | Convert a series of points, or a matrix of coordinates, into a line
points2odf | Convert a series of points into a dataframe of origins and destinations

## -- Q --

quadrant | Split a spatial object into quadrants

## -- R --

read_stats19_ac | Import and format UK 'Stats19' road traffic casualty data
read_stats19_ca | Import and format UK 'Stats19' road traffic casualty data
read_stats19_ve | Import and format UK 'Stats19' road traffic casualty data
read_table_builder | Import and format Australian Bureau of Statistics (ABS) TableBuilder files
reproject | Reproject lat/long spatial object so that they are in units of 1m
route | Plan routes on the transport network
routes_fast | spatial lines dataset of commuter flows on the travel network
routes_fast_sf | spatial lines dataset of commuter flows on the travel network
routes_slow | spatial lines dataset of commuter flows on the travel network
routes_slow_sf | spatial lines dataset of commuter flows on the travel network
route_cyclestreet | Plan a single route with CycleStreets.net
route_cyclestreets | Plan a single route with CycleStreets.net
route_graphhopper | Plan a route with the graphhopper routing engine
route_network | spatial lines dataset representing a route network
route_network_sf | spatial lines dataset representing a route network
route_osrm | Plan a route with OSRM
route_transportapi_public | Plan a single route with TransportAPI.com

## -- S --

sfNetwork-class | An S4 class representing a (typically) transport network
sln2points | Generate spatial points representing nodes on a SpatialLinesNetwork or sfNetwork.
SpatialLinesNetwork | Create object of class SpatialLinesNetwork or sfNetwork
SpatialLinesNetwork-class | An S4 class representing a (typically) transport network
sp_aggregate | Aggregate SpatialPolygonsDataFrame to new geometry.
stplanr | *stplanr: Sustainable Transport Planning with R*
summary-method | Print a summary of a SpatialLinesNetwork
summary-method | Print a summary of a sfNetwork
sum_network_links | Summarise links from shortest paths data
sum_network_routes | Summarise shortest path between nodes on network

## -- T --

table2matrix | Return Matrix containing travel times between origins and destinations
toptail | Clip the first and last n metres of SpatialLines
toptailgs | Clip the first and last n metres of SpatialLines
toptail_buff | Clip the beginning and ends SpatialLines to the edge of SpatialPolygon borders

## -- U --

update_line_geometry | Update line geometry

## -- V --

viaroute | Query OSRM service and return json string result
viaroute2sldf | Convert json result of OSRM routing query to SpatialLinesDataFrame

## -- W --

weightfield | Get or set weight field in SpatialLinesNetwork
weightfield-method | Get or set weight field in SpatialLinesNetwork
weightfield<- | Get or set weight field in SpatialLinesNetwork
weightfield<--method | Get or set weight field in SpatialLinesNetwork
writeGeoJSON | Write to geojson easily

## -- Z --

zones | Spatial polygons of home locations for flow analysis.
zones_sf | Spatial polygons of home locations for flow analysis.