regexr (version 1.0.2)

comments: Get/Set Comments From a regexr Object

Description

comments - Get the comments from a regexr object. comments<- - Set the comments of a regexr object. set_comments - This is a convenience function that sets the comments on a regexr object and returns the object.

Usage

comments(x, ...)

comments(x) <- value

set_comments(x, y)

Arguments

x

A regexr object.

value

The comment(s) to assign.

y

The comments to assign.

...

Ignored.

Value

• comments - Returns a list of comments. set_comments - Returns a regexr object.

Examples

minimal <- construct("a", "b", "c" %:)% "Comment #3")
minimal
comments(minimal)
comments(minimal)[2] <- "A comment"
comments(minimal)

minimal <- construct("a", "b", "c")
out <- set_comments(minimal, paste("comment", 1:3))
comments(out)