| Title: | Interface to 'ArcGIS' 'Python' Modules |
| Version: | 0.4-0 |
| Description: | An interface to the 'ArcGIS' 'arcpy' and 'arcgis' 'python' API https://pro.arcgis.com/en/pro-app/latest/arcpy/get-started/arcgis-api-for-python.htm. Provides various tools for installing and configuring a 'Conda' environment for accessing 'ArcGIS' geoprocessing functions. Helper functions for manipulating and converting 'ArcGIS' objects from R are also provided. |
| URL: | https://github.com/mkoohafkan/arcpy, https://hydroecology.net/arcpy/ |
| BugReports: | https://github.com/mkoohafkan/arcpy/issues |
| SystemRequirements: | Conda (>= 4.6), ArcGIS Pro (>= 3.0) |
| Depends: | R (≥ 4.2) |
| Imports: | stats, reticulate (≥ 1.31) |
| Suggests: | tibble (≥ 3.0), knitr (≥ 1.21), rmarkdown (≥ 1.11), testthat (≥ 2.1.0), rstudioapi (≥ 0.7), sf, terra |
| License: | GPL (≥ 3) |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.2.3 |
| VignetteBuilder: | knitr |
| Config/testthat/edition: | 3 |
| NeedsCompilation: | no |
| Packaged: | 2024-01-20 04:09:45 UTC; michael |
| Author: | Michael Koohafkan [aut, cre] |
| Maintainer: | Michael Koohafkan <michael.koohafkan@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2024-01-22 17:32:51 UTC |
Interface to ArcPy
Description
An interface to the ArcGIS arcpy Python module via the
R-Python interface provided by reticulate. Loading the
packages exposes the arcpy and arcgis python modules for
accessing the ArcGIS geoprocessor.
See the vignettes to get started.
Author(s)
Maintainer: Michael Koohafkan michael.koohafkan@gmail.com
See Also
Get Arcpy Version
Description
Verify the supplied arcpy module version and identify the required Python version.
Usage
arcpy_version(version, conda = "auto", channel = "esri", forge = TRUE)
Arguments
version |
The arcpy module version. |
conda |
The path to a |
channel |
An optional character vector of conda channels to include.
When specified, the |
forge |
Boolean; include the conda-forge repository? |
Value
A named list providing version numbers of arcpy and Python.
Table Row Removal with arcpy.da
Description
Drop records from a table (e.g. attribute table of a layer) with the arcpy.da module.
Usage
da_drop(table.path, rows)
Arguments
table.path |
The file path to the table. |
rows |
The row indexes to drop. |
Value
(Invisible) The path to the table, i.e. table.path.
Examples
## Not run:
arcpy$env$workspace = tempdir()
arcpy$env$scratchWorkspace = tempdir()
fc = arcpy$management$CopyFeatures(system.file("CA_Counties",
"CA_Counties_TIGER2016.shp", package = "arcpy"), "CA_Counties")
d = da_read(fc, c("STATEFP", "COUNTYFP"))
drop.rows = which(d$STATEFP == "06" & d$COUNTYFP == "067")
da_drop(fc, drop.rows)
## End(Not run)
List Attribute Table Fields
Description
Read attribute table field names with 'arcpy.da“ module.
Usage
da_fields(table.path)
Arguments
table.path |
The file path to the table. |
Value
A vector of field names.
Examples
## Not run:
arcpy$env$workspace = tempdir()
arcpy$env$scratchWorkspace = tempdir()
fc = arcpy$management$CopyFeatures(system.file("CA_Counties",
"CA_Counties_TIGER2016.shp", package = "arcpy"), "CA_Counties")
da_fields(fc)
## End(Not run)
Table Insertion with arcpy.da
Description
Insert records into a table (e.g. attribute table of a layer) with the arcpy.da module.
Usage
da_insert(table.path, d)
Arguments
table.path |
The file path to the table. |
d |
The data to write to |
Value
(Invisible) The path to the table, i.e. table.path.
Examples
## Not run:
arcpy$env$workspace = tempdir()
arcpy$env$scratchWorkspace = tempdir()
fc = arcpy$management$CopyFeatures(system.file("CA_Counties",
"CA_Counties_TIGER2016.shp", package = "arcpy"), "CA_Counties")
d = da_read(fc, c("ALAND", "CLASSFP"))
add.d = data.frame(ALAND= 1e4, CLASSFP = "H2",
stringsAsFactors = FALSE)
da_insert(fc, add.d)
## End(Not run)
Read Table with arcpy.da
Description
Read a table (e.g. attribute table of a layer) with the
arcpy.da module.
Usage
da_read(table.path, fields, simplify = TRUE)
Arguments
table.path |
The file path to the table. |
fields |
A vector of field names or column indices to retrieve. |
simplify |
If |
Details
This implementation may be faster than accessing the
@data slot of an object created from rgdal::readOGR
in cases where there are a very large number of features. An
additional advantage of da_read is that it can read
raster attribute tables and stand-alone tables stored in file
geodatabases, which is not supported by rgdal::readOGR.
Value
a dataframe with columns corresponding to fields.
Examples
## Not run:
arcpy$env$workspace = tempdir()
arcpy$env$scratchWorkspace = tempdir()
fc = arcpy$management$CopyFeatures(system.file("CA_Counties",
"CA_Counties_TIGER2016.shp", package = "arcpy"), "CA_Counties")
da_read(fc, c("COUNTYFP", "ALAND"))
## End(Not run)
Update Table with arcpy.da
Description
Update a table (e.g., attribute table of a layer) with the arcpy.da module.
Usage
da_update(table.path, d)
Arguments
table.path |
The file path to the table. |
d |
The data to write to |
Value
(Invisible) The path to the table, i.e. table.path.
Examples
## Not run:
arcpy$env$workspace = tempdir()
arcpy$env$scratchWorkspace = tempdir()
fc = arcpy$management$CopyFeatures(system.file("CA_Counties",
"CA_Counties_TIGER2016.shp", package = "arcpy"), "CA_Counties")
d = da_read(fc, "ALAND")
d["ALAND"] = d$ALAND+ 5000
da_update(fc, d)
## End(Not run)
Feature From ArcGIS Object
Description
Convert an ArcGIS object to an sf object.
Usage
feature_from_arcpy(x, ...)
Arguments
x |
An ArcGIS vector object. |
... |
Reserved for future expansion. |
Value
A sf object.
Feature To ArcGIS Object
Description
Convert an sf object to ArcGIS.
Usage
feature_to_arcpy(x, ...)
Arguments
x |
An |
... |
Reserved for future expansion. |
Value
An ArcGIS vector object.
Fields Exist
Description
Check if specified fields are present in a table.
Usage
fields_exist(table.path, fields)
Arguments
table.path |
The file path to the table. |
fields |
The field names. |
Value
No return value; will produce an error if any of the specified fields are not present in the table.
Install ArcGIS Conda Environment
Description
Create a Conda environment with the "arcpy" module.
Usage
install_arcpy(
method = "conda",
conda = "auto",
version = NULL,
envname = "r-arcpy",
extra_packages = NULL,
restart_session = TRUE,
python_version = NULL,
channel = "esri",
forge = TRUE,
...,
new_env = identical(envname, "r-arcpy")
)
Arguments
method |
Installation method. By default, "auto" automatically finds a method that will work in the local environment. Change the default to force a specific installation method. Note that the "virtualenv" method is not available on Windows. |
conda |
The path to a |
version |
Arcpy version to install. Note that the requested arcpy version must match your ArcGIS Pro version. |
envname |
The name, or full path, of the environment in which Python
packages are to be installed. When |
extra_packages |
Additional Python packages to install along with arcpy. |
restart_session |
Restart R session after installing (note this will only occur within RStudio). |
python_version |
Pass a string like "3.9" to request that
conda install a specific Python version. Note that the Python
version must be compatible with the requested arcpy version. If
|
channel |
An optional character vector of conda channels to include.
When specified, the |
forge |
Boolean; include the conda-forge repository? |
... |
other arguments passed to |
new_env |
If |
Details
The Conda environment must be configured to match the ArcGIS Pro version currently installed. If ArcGIS Pro is updated, the Conda environment must be recreated.
Value
(Invisible) TRUE if the Conda environment was created
successfully.
Raster From ArcGIS Object
Description
Convert an ArcGIS raster object to a SpatRaster object.
Usage
raster_from_arcpy(x, ...)
Arguments
x |
An ArcGIS raster object. |
... |
Reserved for future expansion. |
Value
A SpatRaster object.
Raster To ArcGIS Object
Description
Convert a SpatRaster object to ArcGIS.
Usage
raster_to_arcpy(x, ...)
Arguments
x |
A |
... |
Reserved for future expansion. |
Value
An ArcGIS Raster object.
Objects exported from other packages
Description
These objects are imported from other packages. Follow the links below to see their documentation.
- reticulate
%as%,as_iterator,import,iter_next,iterate,py_help,use_condaenv
R to/from ArcGIS Object
Description
Convert rasters and features between R and ArcGIS.
Usage
to_arcpy(x, ...)
from_arcpy(x, ...)
Arguments
x |
A raster or feature. |
... |
Reservered for future expansion. |
Value
For to_arcpy(), an ArcGIS raster or feature layer.
For from_arcpy(), a SpatRaster or sf object.
List Field Tokens
Description
Return a list of possible field tokens.
Usage
tokens
Format
An object of class character of length 13.
Details
Possible tokens are listed below. Note that not all tokens are valid for all geometries.
OID@ The OBJECTID for the feature.
SHAPE@ A geometry object for the feature.
SHAPE@XY A tuple of the feature's centroid x,y coordinates.
SHAPE@TRUECENTROID A tuple of the feature's true centroid x, y coordinates.
SHAPE@X A double of the feature's x-coordinate.
SHAPE@Y A double of the feature's y - coordinate.
SHAPE@Z A double of the feature s z-coordinate.
SHAPE@M A double of the feature's m - value.
SHAPE@JSON The esri JSON string representing the geometry.
SHAPE@WKB The well-known binary(WKB) representation for OGC geometry. It provides a portable representation of a geometry value as a contiguous stream of bytes.
SHAPE@WKT The well-known text(WKT) representation for OGC geometry. It provides a portable representation of a geometry value as a text string.
SHAPE@AREA A double of the feature 's area.
SHAPE@LENGTH A double of the feature' s length.
Value
A vector of field names.