getComments.PSRoot: Get the comments associated with an object

Description Usage Arguments Value Author(s) See Also Examples

Description

Get the comments associated with an object.

The comment field can contain any type of object.

Usage

1
2
## S3 method for class 'PSRoot'
getComments(this, ...)

Arguments

this

A PSRoot object.

...

Not used.

Value

The value of the comment field.

Author(s)

Botond Sipos, Gregory Jordan

See Also

For more information see PSRoot.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
	# create an object
	o<-PSRoot()
	# add some comments
	setComments(o,"Random comment")
	# get the comment
	getComments(o)
	# get/set the comment via virtual fiels
	o$comments<-"Second random comment"
	o$comments
 

phylosim documentation built on Nov. 22, 2019, 1:07 a.m.