notes: notes Function

Description Usage Arguments Value Examples

View source: R/comments.R

Description

This function prints the comments associated with the supplied R object. If a single comment is specified by

Usage

1
2
notes(x, ids = NULL, commentonly = FALSE, showtimestamps = FALSE,
  showcategories = FALSE)

Arguments

x

R object to print the comments from

ids

vector of comment id's to return

commentonly

default = FALSE, set to TRUE to only return the comment text

showtimestamps

boolean to indicate if timestamps for each comment should be shown or hidden

showcategories

boolean to indicate if comment categories for each comment should be shown or hidden

Value

print out of comments in tabular form

Examples

1
2
3
4
## Not run: 
df <- notes(df)

## End(Not run)

mandpd/comments documentation built on May 5, 2019, 7:57 p.m.