enotes: enotes Function

Description Usage Arguments Value Examples

View source: R/comments.R

Description

This function enables comments to be added to the supplied R object.

Usage

1
enotes(x, comment = "", category = "none")

Arguments

x

R object to which comments should be added

comment

optional comment to be added to R object

category

optional category tag for comment

Value

Original R object wrapped for use with comment functions

Examples

1
2
3
4
5
## Not run: 
df <- enotes(cars)
df <- enotes(cars, 'based on cars dataset from http://mysite.com')

## End(Not run)

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