R/ls.r

In adamlilith/fasterRaster: Faster Raster and Spatial Vector Processing Using 'GRASS GIS'

#' List objects in the active GRASS session
#'
#' Display the `sources` (see `sources()`) of all rasters and/or vectors that have been exported to or created in the active **GRASS** session"s location and mapset.
#'
#' @param type The type of spatial objects to display. This can include `"rasters"` (all rasters), `"vectors"` (all spatial vectors), `"rasters3d"` (3D-rasters), and/or `"groups"` (groups). Partial matching is supported. If missing, all objects are displayed.
#' 
#' @return Character vector of names of **GRASS** objects.
#'
#' @seealso [ls()]
#'
#' @aliases .ls
#' @rdname ls
#' @keywords internal
.ls <- function(type = c("rasters", "vectors", "rasters3d", "groups")) {

	rov <- c("rasters", "vectors", "rasters3d", "groups")
	type <- omnibus::pmatchSafe(type, rov, useFirst = TRUE, n = length(rov))
	if (is.null(type)) type <- rov

	# find rasters and vector
	rasts <- vects <- rasts3d <- vects3d <- groups <- character()
	match <- pmatch(type, rov)
	
	# failure to match
	if (anyNA(match)) {

		warning("No matches.", immediate. = TRUE)
		out <- NULL
		
	# specific match
	} else {
		
		# rasters
		if (any(match == 1L)) {
			rasts <- rgrass::execGRASS("g.list", flags = .quiet(), type = "raster", intern = TRUE, echoCmd = FALSE)
			if (length(rasts) > 0L) names(rasts) <- rep("raster", length(rasts))
			rasts <- sort(rasts)
		}
		
		# 3D rasters
		if (any(match == 3L)) {
			rasts3d <- rgrass::execGRASS("g.list", flags=.quiet(), type="raster_3d", intern=TRUE, echoCmd=FALSE)
			if (length(rasts3d) > 0L) names(rasts3d) <- rep("raster3d", length(rasts3d))
			rasts3d <- sort(rasts3d)
		}
		
		# vectors
		if (any(match == 2L)) {
			vects <- rgrass::execGRASS("g.list", flags=.quiet(), type="vector", intern=TRUE, echoCmd=FALSE)
			if (length(vects) > 0L) names(vects) <- rep("vector", length(vects))
			vects <- sort(vects)
		}
		
		# groups
		if (any(match == 4L)) {
			groups <- rgrass::execGRASS("g.list", flags=.quiet(), type="group", intern=TRUE, echoCmd=FALSE)
			if (length(groups) > 0L) names(groups) <- rep("group", length(groups))
			groups <- sort(groups)
		}
		
		out <- c(rasts, rasts3d, vects, groups)

	}
		
	out
	
}