as_tibble.Spat: Coerce a 'SpatVector' or 'SpatRaster' object to data frames
In tidyterra: 'tidyverse' Methods and 'ggplot2' Helpers for 'terra' Objects

as_tibble.Spat

R Documentation

Coerce a `SpatVector` or `SpatRaster` object to data frames

Description

as_tibble() methods for SpatRaster and SpatVector objects.

Usage

## S3 method for class 'SpatRaster'
as_tibble(x, ..., xy = FALSE, na.rm = FALSE, .name_repair = "unique")

## S3 method for class 'SpatVector'
as_tibble(x, ..., geom = NULL, .name_repair = "unique")

Arguments

`x`	A `SpatRaster` created with `terra::rast()` or a `SpatVector` created with `terra::vect()`.
`...`	Arguments passed on to `terra::as.data.frame()`.
`xy`	logical. If `TRUE`, the coordinates of each raster cell are included
`na.rm`	logical. If `TRUE`, cells that have a `NA` value in at least one layer are removed. If the argument is set to `NA` only cells that have `NA` values in all layers are removed
`.name_repair`	Treatment of problematic column names: `"minimal"`: No name repair or checks, beyond basic existence. `"unique"`: Make sure names are unique and not empty. `"check_unique"`: (default value), no name repair, but check they are `unique`. `"universal"`: Make the names `unique` and syntactic. a function: apply custom name repair (e.g., `.name_repair = make.names` for names in the style of base R). A purrr-style anonymous function, see `rlang::as_function()`.
`geom`	character or NULL. If not NULL, either "WKT" or "HEX", to get the geometry included in Well-Known-Text or hexadecimal notation. If `x` has point geometry, it can also be "XY" to add the coordinates of each point

Value

A tibble.

terra equivalent

terra::as.data.frame()

Methods

Implementation of the generic tibble::as_tibble() function.

`SpatRaster` and `SpatVector`

The tibble is returned with an attribute including the crs of the initial object in WKT format (see pull_crs()).

About layer/column names

When coercing SpatRaster objects to data frames, x and y names are reserved for geographic coordinates of each cell of the SpatRaster It should be also noted that terra allows layers with duplicated names.

In the process of coercing a SpatRaster to a tibble, tidyterra may rename the layers of your SpatRaster for overcoming this issue. Specifically, layers may be renamed on the following cases:

Layers with duplicated names.
When coercing to a tibble, if xy = TRUE, layers named x or y would be renamed.
When working with tidyverse methods (i.e. filter.SpatRaster()), the latter would happen as well.

tidyterra would display a message informing of the changes on the names of the layer.

The same issue happens for SpatVector with names geometry (when geom = c("WKT", "HEX")) and x, y (when geom = "XY"). These are reserved names representing the geometry of the SpatVector (see terra::as.data.frame()). If geom is not NULL then the logic described for SpatRaster would apply as well for the columns of the SpatVector.

Examples


library(terra)
# SpatRaster
f <- system.file("extdata/cyl_temp.tif", package = "tidyterra")
r <- rast(f)

as_tibble(r, na.rm = TRUE)

as_tibble(r, xy = TRUE)

# SpatVector

f <- system.file("extdata/cyl.gpkg", package = "tidyterra")
v <- vect(f)

as_tibble(v)

tidyterra documentation built on April 15, 2025, 1:15 a.m.