Generate Service Areas (Async)

Submits an asynchronous geoprocessing job to generate service areas around facilities using the ArcGIS /GenerateServiceAreas GP service.

Usage

find_service_areas_job(
  facilities,
  break_values = NULL,
  break_units = NULL,
  travel_mode = NULL,
  travel_direction = NULL,
  time_of_day = NULL,
  use_hierarchy = NULL,
  uturn_at_junctions = NULL,
  polygons_for_multiple_facilities = NULL,
  polygon_overlap_type = NULL,
  detailed_polygons = NULL,
  polygon_trim_distance = NULL,
  polygon_simplification_tolerance = NULL,
  polygon_detail = NULL,
  output_type = NULL,
  analysis_region = NULL,
  restrictions = NULL,
  impedance = NULL,
  time_impedance = NULL,
  distance_impedance = NULL,
  ignore_invalid_locations = TRUE,
  output_format = "feature_set",
  point_barriers = NULL,
  line_barriers = NULL,
  polygon_barriers = NULL,
  token = arcgisutils::arc_token()
)

Arguments

facilities

An sf or sfc object containing point geometries representing the facilities around which service areas are generated.

break_values

Numeric vector. Service area sizes. Units are determined by break_units. Default: NULL (API default: 5 10 15).

break_units

Character. Units for break_values. One of: "meters", "kilometers", "feet", "yards", "miles", "nautical_miles", "seconds", "minutes", "hours", "days". Default: NULL (API default: "minutes").

travel_mode

Character. The name or ID of the travel mode to use. See get_travel_modes() for available options. Default: NULL.

travel_direction

Character. Direction of travel relative to facilities. One of: "away", "towards". Default: NULL (API default: "away").

time_of_day

POSIXct. The departure time for the routes. When NULL, static average speeds are used. Default: NULL.

use_hierarchy

Logical. Whether to use the street hierarchy when finding routes. Default: NULL (API default: TRUE).

uturn_at_junctions

Character. U-turn policy at junctions. One of: "allow_backtrack", "deadend_intersection", "deadend", "no_backtrack". Default: NULL.

polygons_for_multiple_facilities

Character. How service area polygons from multiple facilities are generated. One of: "overlapping", "not_overlapping", "merge". Default: NULL (API default: "overlapping").

polygon_overlap_type

Character. Whether polygons are rings or disks. One of: "rings", "disks". Default: NULL (API default: "rings").

detailed_polygons

Logical. Generate detailed polygons. Default: NULL (API default: FALSE).

polygon_trim_distance

List with elements distance (numeric) and units (character). Trim polygons to within this distance of the network. Default: NULL.

polygon_simplification_tolerance

List with elements distance (numeric) and units (character). Simplification tolerance for output polygons. Default: NULL.

polygon_detail

Character. Level of detail for output polygons. One of: "standard", "generalized", "high". Default: NULL (API default: "standard").

output_type

Character. Type of output to generate. One of: "polygons", "lines", "polygons_and_lines". Default: NULL (API default: "polygons").

analysis_region

Character. Region for the analysis. One of: "europe", "japan", "korea", "middle_east_and_africa", "north_america", "south_america", "south_asia", "thailand". Default: NULL (auto-detected).

restrictions

Character vector. Restriction names to apply. Default: NULL.

impedance

Character. Impedance type. One of: "travel_time", "minutes", "truck_travel_time", "truck_minutes", "walk_time", "miles", "kilometers". Default: NULL.

time_impedance

Character. Time-based impedance. One of: "minutes", "travel_time", "walk_time", "truck_minutes", "truck_travel_time". Default: NULL.

distance_impedance

Character. Distance-based impedance. One of: "miles", "kilometers". Default: NULL.

ignore_invalid_locations

Logical. Whether to ignore invalid input locations. Default: TRUE.

output_format

Character. Format for output features. One of: "feature_set", "json_file", "geojson_file". Default: "feature_set".

point_barriers

Point barriers as sf or sfc object. Default: NULL.

line_barriers

Line barriers as sf or sfc object. Default: NULL.

polygon_barriers

Polygon barriers as sf or sfc object. Default: NULL.

token

Authorization token. Default: arcgisutils::arc_token().

Value

A find_service_areas_job R6 object inheriting from arcgisutils::arc_gp_job. Call $start() to submit and $results to retrieve output.

References

API Reference

See also

Other async: download_od_results(), download_service_area_results(), find_closest_facilities_job(), find_routes_job(), last_mile_delivery(), location_allocation_job(), od_cost_matrix_job(), route_vehicles_job()

Other service area: download_service_area_results(), find_service_areas()

Examples

if (FALSE) { # \dontrun{
# This example is not executed since it requires a network connection
# to ArcGIS Online and a valid authentication token
library(sf)
library(arcgisutils)
set_arc_token(auth_user())

facilities <- st_sfc(
  st_point(c(-122.4194, 37.7749)),
  st_point(c(-122.0312, 37.3318)),
  crs = 4326
)

job <- find_service_areas_job(facilities, break_values = c(5, 10, 15))
job$start()
result <- job$results
} # }