R/sf2arc.R

In FluvialGeomorph/fluvgeo: A Package for Fluvial Geomorphic Analysis

#' @title Converts an \code{sf} object to an ArcGIS feature class
#'
#' @description Converts an \code{sf} object to an ArcGIS feature class in
#'     the specified geodatabase feature class.
#'
#' @export
#' @param sf_object     \code{sf} object
#' @param fc_path       character; Path to the ArcGIS output feature class. The
#'                      feature class must reside in a file geodatabase feature
#'                      dataset.
#'
#' @return Writes the \code{sf} object to an ArcGIS feature class specified
#' by fc_path.
#'
#' @details This function requires the prior installation of the
#' \code{arcgisbinding} package AND a licensed installation of ESRI
#' \code{ArcGIS Pro}. The \code{arcgisbinding} package can be installed
#' from within \code{ArcGIS Pro}.
#'
#' @seealso This function for loading data from an ESRI spatial dataset.
#'
#' @references
#' \describe{
#'   \item{ArcGIS Pro}{\url{https://pro.arcgis.com/}}
#'   \item{\code{arcgisbinding}}{
#'   \url{https://r-arcgis.github.io/assets/arcgisbinding-vignette.html}}
#' }
#'
#' @importFrom assertthat assert_that
#' @importFrom stringr str_detect
#' @importFrom arcgisbinding arc.write
#'
sf2arc <- function(sf_object, fc_path) {
  # Check parameters
  assert_that(stringr::str_detect(class(sf_object)[1], "sf"),
              msg = "sf_object must be of class `sf`")

  # Use the `shapeinfo` object with arc.write to preserve crs
  # https://github.com/R-ArcGIS/r-bridge/issues/38

  # Get sf Spatial data class
  sf_shape_type <- sf::st_geometry_type(sf_object, by_geometry = FALSE)

  # Set ESRI shape type to sf shape type
  esri_shape_type <- switch(as.character(sf_shape_type),
                            "POINT"        = "Point",
                            "MULTIPOINT"   = "Multipoint",
                            "LINESTRING"   = "Polyline",
                            "POLYGON"      = "Polygon",
                            "MULTIPOLYGON" = "Multipolygon")

  # Get the GDB `stream_network` shapeinfo object (used for all GDB objects)
  gdb_feature_dataset_path <- dirname(fc_path)
  stream_network_path <- file.path(gdb_feature_dataset_path,
                                   "stream_network")
  arcobj <- arcgisbinding::arc.open(stream_network_path)
  shape_info <- arcobj@shapeinfo

  # Set the `shapeinfo` type parameter (undocumented)
  shape_info$type <- esri_shape_type

  # Write the sf object to a geodatabase feature class
  arcgisbinding::arc.write(path = fc_path,
                           data = sf_object,
                           #coords = colnames(sf_object),
                           shape_info = shape_info,
                           validate = TRUE,
                           overwrite = TRUE)
}