metadata {spacesRGB} | R Documentation |
metadata of a TransferFunction object
Description
Retrieve or set the metadata of a TransferFunction object. The user is free to set this as he/she wishes.
Usage
## S3 method for class 'TransferFunction'
metadata( x, ...)
## S3 replacement method for class 'TransferFunction'
metadata( x, add=FALSE ) <- value
Arguments
x |
a |
... |
optional names of metadata to return |
value |
a named |
add |
if |
Details
The metadata list is stored as attr(x,'metadata')
.
After construction this list is empty.
Value
metadata(x)
with no additional arguments returns the complete named list of metadata.
If arguments are present, then only those metadata
items are returned.
See Also
Examples
## Not run:
# get list of *all* metadata
metadata(TF)
# get just the number 'gamma'
metadata( TF, 'gamma' )
# alternative method to get just the number 'gamma'
metadata( TF )$gamma
# set the 'date'
metadata( TF ) = list( date="2016-04-01" )
## End(Not run)