# Spatial Network Analysis

## Documentation for package ‘alcyon’ version 0.9.0

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

## Help Pages

agentAnalysis | Agent Analysis
AgentLookMode | Agent look modes.
alcyon-coercion | Coercion between sf and alcyon map classes
AllLineShapeGraph-class | All-line Axial ShapeGraph
allToAllTraverse | All-to-all traversal
axialAnalysisLocal | Axial analysis - local metrics
AxialShapeGraph | Axial ShapeGraph
AxialShapeGraph-class | Axial ShapeGraph
AxialShapeGraph_subset | Subset AxialShapeGraph objects
axialToSegmentShapeGraph | Axial to Segment ShapeGraph
blockLines | Block lines on a LatticeMap
coerce-method | Coercion between sf and alcyon map classes
connections | Get map connections
connections-method | Get the Axial ShapeGraph connections
connections-method | Get the LatticeMap connections
connections-method | Get the Segment ShapeGraph connections
createGrid | Create a LatticeMap through a grid
depthmap.axmanesque.colour | Colour Palettes from depthmapX
depthmap.bluered.colour | Colour Palettes from depthmapX
depthmap.classic.colour | Colour Palettes from depthmapX
depthmap.grayscale.colour | Colour Palettes from depthmapX
depthmap.nicehsb.colour | Colour Palettes from depthmapX
depthmap.purpleorange.colour | Colour Palettes from depthmapX
fillGrid | Fill a LatticeMap's grid starting from one or more points
getTopFeatures | Extract top x percent of features
indexToRefID | Ref ID to index and vice-versa
isovist | Create isovists at point and direction angle
isovist2pts | Create isovists using two points
LatticeMap | LatticeMap
LatticeMap-class | LatticeMap
LatticeMap_subset | Subset LatticeMap objects
linkCoords | Link map points/lines as if selecting them using points
linkCoords-method | Link two Axial Lines (coordinates)
linkCoords-method | Link two LatticeMap Cells (coordinates)
linkRefs | Link map points/lines using their refs
linkRefs-method | Link two Axial Lines (refs)
linkRefs-method | Link two LatticeMap Cells (refs)
links | Get map links
links-method | Get the Axial ShapeGraph links
links-method | Get the LatticeMap links
makeAllLineMap | Create an All-line Map
makeAxmanesqueColour | Single Colour from depthmapX's Palettes
makeBlueRedColour | Single Colour from depthmapX's Palettes
makeColour | Single Colour from depthmapX's Palettes
makeDepthmapClassicColour | Single Colour from depthmapX's Palettes
makeGreyScaleColour | Single Colour from depthmapX's Palettes
makeNiceHSBColour | Single Colour from depthmapX's Palettes
makePurpleOrangeColour | Single Colour from depthmapX's Palettes
makeVGAGraph | Create a graph between visible cells in the LatticeMap
makeVGALatticeMap | Create a LatticeMap grid, fill it and make the graph
matchPointsToLines | Match points to lines
name | Get map name
name-method | Get the LatticeMap name
name-method | Get the ShapeMap name
oneToAllTraverse | One-to-all traversal
oneToOneTraverse | One-to-one traversal
palettes | Colour Palettes from depthmapX
plot.LatticeMap | plot a LatticeMap
readMetaGraph | Read MetaGraph
reduceToFewest | Reduce an All-line Map to two types of fewest-line maps
refIDtoIndex | Ref ID to index and vice-versa
refIdToIndexAndBack | Ref ID to index and vice-versa
SegmentShapeGraph | Segment ShapeGraph
SegmentShapeGraph-class | Segment ShapeGraph
SegmentShapeGraph_subset | Subset SegmentShapeGraph objects
segmentTulipLeafChoice | Segment Tulip Leaf Choice
shapegraphToGraphData | Conversion of shapegraph to graph data
ShapeMap | ShapeMap class
ShapeMap-class | ShapeMap class
shapeMapToPolygonSf | ShapeMap to sf Polygon map
ShapeMap_subset | Subset ShapeMap objects
TraversalType | Traversal types
unlinkAtCrossPoint | Unlink map lines at their crossing point
unlinkAtCrossPoint-method | Unlink two Axial Lines (crosspoint)
unlinkCoords | Unlink map points/lines as if selecting them using points
unlinkCoords-method | Unlink two Axial Lines (coordinates)
unlinkCoords-method | Unlink two LatticeMap Cells (coordinates)
unlinkRefs | Unlink map points/lines using their refs
unlinkRefs-method | Unlink two Axial Lines (refs)
unlinkRefs-method | Unlink two LatticeMap Cells (refs)
unmakeVGAGraph | Unmake the graph in a LatticeMap
vgaIsovist | Visibility Graph Analysis - isovist metrics
VGALocalAlgorithm | VGA Local Analysis algorithms.
vgaThroughVision | Visibility Graph Analysis - Through Vision
vgaVisualLocal | Visibility Graph Analysis - Visual local metrics
[.AxialShapeGraph | Subset AxialShapeGraph objects
[.LatticeMap | Subset LatticeMap objects
[.SegmentShapeGraph | Subset SegmentShapeGraph objects
[.ShapeMap | Subset ShapeMap objects
[<-.AxialShapeGraph | Subset AxialShapeGraph objects
[<-.LatticeMap | Subset LatticeMap objects
[<-.SegmentShapeGraph | Subset SegmentShapeGraph objects
[<-.ShapeMap | Subset ShapeMap objects