metags: Set or get metadata

In rspatial/terra: Spatial Data Analysis

Set or get metadata

Description

You can set arbitrary metadata to (layers of) a SpatRaster using "name=value" tags. When wring a SpatRaster to a GTiff file, these tags are written to file.

Usage

## S4 replacement method for signature 'SpatRaster'
metags(x, layer=NULL, domain="USER_TAGS")<-value

## S4 method for signature 'SpatRaster'
metags(x, layer=NULL, name=NULL)

## S4 replacement method for signature 'SpatRasterDataset'
metags(x, dataset=NULL)<-value

## S4 method for signature 'SpatRasterDataset'
metags(x, dataset=NULL, name=NULL)

Arguments

x	SpatRaster
layer	NULL, positive integer or character. If the value is NULL, the tags assigned or returned are for the SpatRaster. Otherwise for the layer number(s) or name(s)
domain	character. Use "" for the default domain
name	character
value	character of "name=value" or two-column (name, value) or three-column (name, value, domain) matrix or data.frame
dataset	NULL, positive integer or character. If the value is NULL, the tags assigned or returned are for the SpatRasterDataset/SpatRasterCollection. Otherwise for the datset number(s) or name(s)

Value

SpatRaster (metags<-), or data.frame

Examples

r <- rast(ncol=5, nrow=5)
m <- cbind(c("one", "two", "three"), c("ABC", "123", "hello"))
metags(r) <- m
metags(r)

metags(r) <- c("another_tag=another_value", "one more=this value")
metags(r)

metags(r) <- cbind("AREA_OR_POINT", "Point", "")
metags(r)

metags(r, name="two")

# remove a tag
metags(r) <- cbind("one", "")
metags(r) <- "two="
metags(r)

# remove all tags
metags(r) <- NULL
metags(r)

rspatial/terra documentation built on March 1, 2025, 3:50 a.m.