getComment: getComment

View source: R/getComment.R

getCommentR Documentation

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"

Examples


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


magclass documentation built on May 29, 2024, 6:20 a.m.