Sustainable Transport Planning

---

Documentation for package ‘stplanr’ version 1.0.2

• DESCRIPTION file.
• User guides, package vignettes and other documentation.
• Package NEWS.

Help Pages

stplanr-package	*stplanr: Sustainable Transport Planning with R*
angle_diff	Calculate the angular difference between lines and a predefined bearing
bb2poly	Flexible function to generate bounding boxes
bbox_scale	Scale a bounding box
cents_sf	Spatial points representing home locations
destinations_sf	Example destinations data
flow	Data frame 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
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_length	Calculate line length of line with geographic or projected CRS
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
islines	Do the intersections between two geometries create lines?
is_linepoint	Identify lines that are points
line2df	Convert geographic line objects to a data.frame with from and to coords
line2points	Convert a spatial (linestring) object to points
line2pointsn	Convert a spatial (linestring) object to points
line2vertices	Convert a spatial (linestring) object to points
line_bearing	Find the bearing of straight lines
line_breakup	Break up line objects into shorter segments
line_midpoint	Find the mid-point of lines
line_segment	Divide sf LINESTRING objects into regular segments
line_via	Add geometry columns representing a route via intermediary points
mats2line	Convert 2 matrices to lines
n_vertices	Retrieve the number of vertices in sf objects
od2line	Convert origin-destination data to spatial lines
od2odf	Extract coordinates from OD data
odmatrix_to_od	Convert origin-destination data from wide to long format
od_aggregate_from	Summary statistics of trips originating from zones in OD data
od_aggregate_to	Summary statistics of trips arriving at destination zones in OD data
od_coords	Create matrices representing origin-destination coordinates
od_coords2line	Convert origin-destination coordinates into desire lines
od_data_lines	Example of desire line representations of origin-destination data from UK Census
od_data_routes	Example segment-level route data
od_data_sample	Example of origin-destination data from UK Census
od_id	Combine two ID values to create a single ID number
od_id_character	Combine two ID values to create a single ID number
od_id_max_min	Combine two ID values to create a single ID number
od_id_order	Generate ordered ids of OD pairs so lowest is always first This function is slow on large datasets, see szudzik_pairing for faster alternative
od_id_szudzik	Combine two ID values to create a single ID number
od_oneway	Aggregate od pairs they become non-directional
od_to_odmatrix	Convert origin-destination data from long to wide format
onewaygeo	Aggregate flows so they become non-directional (by geometry - the slow way)
osm_net_example	Example of OpenStreetMap road network
overline	Convert series of overlapping lines into a route network
overline2	Convert series of overlapping lines into a route network
overline_intersection	Convert series of overlapping lines into a route network
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
quadrant	Split a spatial object into quadrants
read_table_builder	Import and format Australian Bureau of Statistics (ABS) TableBuilder files
rnet_add_node	Add a node to route network
rnet_boundary_df	Get points at the beginner and end of linestrings
rnet_boundary_points	Get points at the beginner and end of linestrings
rnet_boundary_points_lwgeom	Get points at the beginner and end of linestrings
rnet_boundary_unique	Get points at the beginner and end of linestrings
rnet_breakup_vertices	Break up an sf object with LINESTRING geometry.
rnet_cycleway_intersection	Example of cycleway intersection data showing problems for SpatialLinesNetwork objects
rnet_duplicated_vertices	Get points at the beginner and end of linestrings
rnet_get_nodes	Extract nodes from route network
rnet_group	Assign segments in a route network to groups
rnet_group.default	Assign segments in a route network to groups
rnet_group.sf	Assign segments in a route network to groups
rnet_group.sfc	Assign segments in a route network to groups
rnet_overpass	Example of overpass data showing problems for SpatialLinesNetwork objects
rnet_roundabout	Example of roundabout data showing problems for SpatialLinesNetwork objects
route	Plan routes on the transport network
routes_fast_sf	Spatial lines dataset of commuter flows on the travel network
routes_slow_sf	Spatial lines dataset of commuter flows on the travel network
route_average_gradient	Return average gradient across a route
route_bikecitizens	Get a route from the BikeCitizens web service
route_dodgr	Route on local data using the dodgr package
route_google	Find shortest path using Google services
route_nearest_point	Find nearest route to a given point
route_network_sf	spatial lines dataset representing a route network
route_osrm	Plan routes on the transport network using the OSRM server
route_rolling_average	Return smoothed averages of vector
route_rolling_diff	Return smoothed differences between vector values
route_rolling_gradient	Calculate rolling average gradient from elevation data at segment level
route_sequential_dist	Calculate the sequential distances between sequential coordinate pairs
route_slope_matrix	Calculate the gradient of line segments from a matrix of coordinates
route_slope_vector	Calculate the gradient of line segments from distance and elevation vectors
route_split	Split route in two at point on or near network
route_split_id	Split route based on the id or coordinates of one of its vertices
stplanr	*stplanr: Sustainable Transport Planning with R*
stplanr-deprecated	Deprecated functions in stplanr
toptail	Clip the first and last n metres of SpatialLines
toptail_buff	Clip the beginning and ends of 'sf' LINESTRING objects
zones_sf	Spatial polygons of home locations for flow analysis.