notes.default: notes Default Function

In mandpd/comments: Add comments to your R data frames as you modify them to document the reasons for your changes

Description

This function provides a help message when applied to an R object that has not been enabled for comments.

Usage

## Default S3 method:
notes(x, ids, commentonly, showtimestamps,
  showcategories)

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 the category of each comment should be shown or hidden

Value

message on correct use of function

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