getComment: getComment

In magclass: Data Class and Tools for Handling Spatial-Temporal Data

getComment

Description

Extracts the comment from a MAgPIE-object

Usage

getComment(x)

getComment(x) <- value

setComment(object, nm = NULL)

Arguments

x, object	MAgPIE object
value, nm	A vector containing the comment.

Value

getComment returns the comment attached to a MAgPIE-object, NULL if no comment is present. setComment returns the magpie object with the modified comment.

Functions

• getComment(x) <- value: set comment

• setComment(): set comment

Author(s)

Markus Bonsch

See Also

getRegions, getNames, getYears, getCPR, read.magpie, write.magpie, "magpie"

Other GetterSetter: getCPR(), getCells(), getCoords(), getDim(), getItems(), getNames(), getRegionList(), getRegions(), getSets(), getYears(), setItems(), setNames-methods

Examples

a <- as.magpie(1)
 # returns NULL
 getComment(a)
 # set the comment
 getComment(a) <- c("bla", "blubb")
 getComment(a)

magclass documentation built on April 17, 2026, 5:07 p.m.