In pfrater/arcpullr: Pull Data from an 'ArcGIS REST' API

---

title: "Spatial Queries" output: rmarkdown::html_vignette vignette: > %\VignetteIndexEntry{Introduction to arcpullr} %\VignetteEncoding{UTF-8} %\VignetteEngine{knitr::rmarkdown} editor_options: markdown: wrap: 72

---

To see more complete package documentation check out: https://pfrater.github.io/arcpullr/

---

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  warning = FALSE,
  message = FALSE
)
library(arcpullr)
library(sf)
sf::sf_use_s2(FALSE)

#<img src='../man/figures/logo.png' width="160" height="180" style="border: none; float: right"/>

ArcGIS REST API's may be spatially queried using the get_layer_by_* family of functions. These functions require a spatial object of class sf (i.e. of the R package sf: Simple Features for R) and a Spatial Relationship to be passed to the geometry and sp_rel arguments respectively.

The package contains five functions that can be used to perform spatial queries:

• `get_layer_by_line`
• `get_layer_by_point`
• `get_layer_by_polygon`
• `get_layer_by_multipoint`
• `get_layer_by_envelope` ## URL's for examples Example Source Data
  wzxhzdk:2
  
  ## get_layer_by_line The `get_layer_by_line` function uses A LINSESTRING or MULTILINESTRING sf object to query an ArcGIS REST API. The below example uses a MULTILINESTRING sf object of the Milwaukee River to query the Wisconsin County polygon layer. wzxhzdk:3 wzxhzdk:4 wzxhzdk:5 wzxhzdk:6 ## get_layer_by_point The `get_layer_by_line` function uses a POINT sf object to query an ArcGIS REST API. The below example shows how this can be used to return which rivers intersect with a trout habitat project on Sugar Creek in southeast Wisconsin. wzxhzdk:7 wzxhzdk:8 wzxhzdk:9 wzxhzdk:10 `get_layer_by_point` can also handle multipoint objects. This example shows the same stream as above with a single point, but now with multiple restoration points. wzxhzdk:11 wzxhzdk:12 wzxhzdk:13 wzxhzdk:14 ## get_layer_by_polygon The `get_layer_by_line` function uses a POLYGON sf object to query an ArcGIS REST API. The below examples shows how this can be used to find what rivers are within a particular watershed. wzxhzdk:15 wzxhzdk:16 wzxhzdk:17 ## get_layer_by_envelope The `get_layer_by_envelope` function accepts any sf object to query an ArcGIS REST API using the sf objects bounding box. The below example shows how this is used to query WI's Rivers ArcGIS REST API using a sf POLYGON object of a watershed for a small stream. Note how the results compare to when this same object is queried using the `get_layer_by_poly` function. wzxhzdk:18 wzxhzdk:19 wzxhzdk:20 \ \ ## Combining Spatial and SQL Queries Spatial queries can be combined with SQL statements to further refine queries. ## Spatial Relationship The `sp_rel` argument can be used to define the spatial relationship between the two feature classes involved within a spatial query. The default spatial relationships for the `get_layer_by_poly` function is "contains". All other functions default to "intersects". wzxhzdk:21 wzxhzdk:22 wzxhzdk:23 Using "crosses" returns different records compared to the above example (i.e. this returns records when they cross the polygon border). wzxhzdk:24 wzxhzdk:25 wzxhzdk:26
  ### Lookup Tables The `sp_rel_lookup` data.frame explains the various types of spatial relationships available through ArcGIS REST APIs. wzxhzdk:27
  The `sp_rel_valid` data.frame shows which spatial relationships are valid with different geometry types being queried and used to do spatial queries. wzxhzdk:28 ### The valid_sp_rel Function The `valid_sp_rel` function can be used to to see which spatial relation types are applicable to different geometries. wzxhzdk:29
  
  
  pfrater/arcpullr documentation built on March 16, 2024, 6:29 a.m.