R.comment: Create R comment with JavaScript in RKWard plugin code

View source: R/R.comment.R

R.commentR Documentation

Create R comment with JavaScript in RKWard plugin code

Description

Create R comment with JavaScript in RKWard plugin code

Usage

R.comment(
  ...,
  indent.by = rk.get.indent(escape = TRUE),
  level = 2,
  newline = ""
)

Arguments

...

Character strings to form a comment.

indent.by

A character string defining the indentation string to use. Note that backslashes need to be escaped (e.g. "\t" to produce "\t").

level

Integer, which indentation level to use in the resulting R code, minimum is 1.

newline

Character string, can be set to e.g. "\n" to force a newline after the call.

Value

A character string.

Examples

cat(R.comment("This will become an R comment"))

rkward-community/rkwarddev documentation built on May 9, 2022, 3:02 p.m.