grseb9s / r-bridge

Bridge library to connect ArcGIS and R, including arcgisbinding R library.

R-bridge for ArcGIS

Requirements

• ArcGIS 10.3.1 or later or ArcGIS Pro 1.1 or later (don't have it? try a 60 day trial)
• R Statistical Computing Software, 3.2.0 or later (What is R?)

• 32-bit version required for ArcMap, 64-bit version required for ArcGIS Pro (Note: the installer installs both by default).
• 64-bit version can be used with ArcMap by installing Background Geoprocessing and configuring scripts to run in the background. NOTE: Background geoprocessing only allows using the bridge from ArcGIS, not from within R itself.

####Installation

For most users, the easiest way to install is using the installation toolbox which will install and configure the bridge for ArcGIS 10.3.1+ and Pro 1.1+. Alternatively, downloading the release can be manually installed into R, as shown in this screencast.

####Basic GP Tool script

tool_exec <- function (in_params, out_params)
{
  value0 <- in_params[[1]]
  print(value0)
# ...
  return (out_params)
}

• tool_exec(in_params, out_params) main function

• in_params list of all input parameters. You can get parameter value by index in_params[[1]] or by parameter name in_params$param1
• output_params list of all output and derived parameters.

####Using arcgisbinding in standalone R script

> library(arcgisbinding)
> arc.check_product()

####Documentation

• The arcgisbinding vignette providesan overview of what the bridge does, and how to use it effectively.
• The arcgisbinding manual provides details on each of the functions included within the package.

####Building from source git clone https://github.com/R-ArcGIS/r-bridge.git

• open command prompt and execute >src\build.bat- this will create 'arcgisbinding' R package.

######Build dependencies:

• Visual Studio 2015 Update 3. Get free VC2015 Community
• Rtools 3.2
• roxygen2 (optional) to build documentation: install.packages('roxygen2')
• MiKTeX 2.9 - (optional) to build package PDF

######Documentation dependencies:

• roxygen2, install from R: install.packages('roxygen2')
• MiKTeX 2.9, to build package PDF

###Repository layout

• src\package
  arcgisbinding (native R package) - collection of classes and functions for script-level bindings between R and bridge dll.
• src\proxy
  rarcproxy.dll, rarcproxy_pro.dll - C++, Bridge between ArcGIS (Desktop 10.3.1+, Pro 1.1+) and arcgisbinding

##Project Details

Check out the R-ArcGIS Website for related projects and extensions built on this library.

##Credits

This package depends on the R Statistical Computing Software:

Copyright (C) 2015 The R Foundation for Statistical Computing R is free software and comes with ABSOLUTELY NO WARRANTY. See the COPYRIGHTS file for details.

License

Apache 2.0