R/write_geojson.R

Defines functions create_geojson write_geojson_js write_geojson

Documented in write_geojson write_geojson_js

#' Functions to write GeoJSON files with usage analogous to \code{write.table}.
#' 
#' \code{write_geojson_js} is a simple extension which adds a \code{var} to the 
#' GeoJSON string so leaflet and other JavaScript libraries can assign the 
#' objects easily. 
#' 
#' @param sp Spatial object to be written as GeoJSON file. 
#' 
#' @param file File name of GeoJSON file. 
#' 
#' @param name Name of JavaScript object (only used in \code{write_geojson_js}). 
#' 
#' @param pretty Format the JSON for readability. 
#' 
#' @param round How many decimal points should the coordinate pairs be exported
#' with? Default is maximum but \code{6} is common for spatial data.
#' 
#' @author Stuart K. Grange
#' 
#' @examples
#' \dontrun{
#' 
#' # Export spatial object as GeoJSON file
#' write_geojson(sp_thames_locks, "thames_locks.json", pretty = TRUE)
#' 
#' # Export spatial object as GeoJSON file ready for leaflet
#' write_geojson(sp_thames_locks, "thames_locks.js", name = "data_locks")
#'
#' }
#' 
#' @export 
write_geojson <- function(sp, file, pretty = TRUE, round = NA) {
  
  # Create
  json <- create_geojson(sp, pretty, round)
  
  # Write string to disk
  write(json, file)
  
}


#' @rdname write_geojson
#' 
#' @export 
write_geojson_js <- function(sp, file, name = NA, pretty = TRUE, round = NA) {
  
  # A name
  if (is.na(name[1])) name <- "spatial_object"
  
  # Create
  json <- create_geojson(sp, pretty, round)
  
  # Add the js formatting for an object
  json_js <- stringr::str_c("var ", name, " = [", json, "];")
  
  # Write string to disk
  write(json_js, file)
  
}


# No export
create_geojson <- function(sp, pretty, round) {
  
  # Make json string, will also work for data frames sometimes but will give
  # message
  json <- suppressMessages(
    geojsonio::geojson_json(sp)
  )
  
  # Use jsonlite to do a better job of pretty printing, expensive though
  if (pretty || !is.na(round)) {
    
    # Parse again
    json <- jsonlite::fromJSON(json)
    
    # Max precision is needed here
    json <- jsonlite::toJSON(
      json, 
      pretty = TRUE, 
      auto_unbox = TRUE, 
      digits = round
    )
    
  }
  
  return(json)
  
}
skgrange/gissr documentation built on Feb. 24, 2024, 2:55 p.m.