terra (version 1.8-42)

metags: Set or get metadata

Description

You can set arbitrary metadata to (layers of) a SpatRaster using "name=value", or "domain:name=value" tags or a two (name, value) or three column (name, value, domain) matrix or data.frame.

Usage

# S4 method for SpatRaster
metags(x, layer=NULL, domain="")<-value
# S4 method for SpatRaster
metags(x, layer=NULL, name=NULL)
# S4 method for SpatRasterDataset
metags(x, dataset=NULL)<-value
# S4 method for SpatRasterDataset
metags(x, dataset=NULL, name=NULL)

Value

SpatRaster (metags<-), or data.frame

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. Only used if not specified by value. Use "" for the default domain. Depending on the file format used this may the only domain supported when writing files

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)

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)