# Sustainable Transport Planning

## Documentation for package ‘stplanr’ version 0.8.2

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

A B C D F G I L M N O P Q R S T U 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

## -- 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

## -- D --

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

## -- 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

## -- 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_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

## -- I --

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

## -- L --

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
line2route | Convert straight OD data (desire lines) into routes
line2routeRetry | Convert straight spatial (linestring) object from flow data into routes retrying on connection (or other) intermittent failures
line2vertices | Convert a spatial (linestring) object to points
lineLabels | Label SpatialLinesDataFrame objects
line_bearing | Find the bearing of straight lines
line_breakup | Break up line objects into shorter segments
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_via | Add geometry columns representing a route via intermediary points
l_poly | Line polygon

## -- M --

mapshape | Simplify geometry of spatial objects with the mapshaper library
mapshape_available | Does the computer have mapshaper available?
mats2line | Convert 2 matrices to lines

## -- N --

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
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 origin-destination data to spatial lines
od2line2 | 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_dist | Quickly calculate Euclidean distances of od pairs
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
overline_spatial | Spatial aggregation of routes represented with sp classes

## -- 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_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
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_group.sfNetwork | 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 | 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_average_gradient | Return average gradient across a route
route_bikecitizens | Get a route from the BikeCitizens web service
route_cyclestreets | Plan a single route with CycleStreets.net
route_dodgr | Route on local data using the dodgr package
route_google | Find shortest path using Google services
route_local | Plan a route with local data
route_nearest_point | Find nearest route to a given point
route_network | spatial lines dataset representing a route network
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
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.
sln_add_node | Add node to spatial lines object
sln_clean_graph | Clean spatial network - return an sln with a single connected graph
SpatialLinesNetwork | Create object of class SpatialLinesNetwork or sfNetwork
SpatialLinesNetwork-class | An S4 class representing a (typically) transport network
stplanr | *stplanr: Sustainable Transport Planning with R*
stplanr-deprecated | Deprecated functions in stplanr
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 --

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

## -- 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.