R.utils (version 2.0.0)

VComments: The VComments class

Description

Package: R.utils Class VComments Object ~~| ~~+--SmartComments ~~~~~~~| ~~~~~~~+--VComments Directly known subclasses: LComments public static class VComments extends SmartComments The VComments class.

Usage

VComments(letter="V", verboseName="verbose", ...)

Arguments

letter

The smart letter.

verboseName

The name of the verbose object.

...

Not used.

Fields and Methods

Methods: rll{ convertComment Converts a verbose comment to R code. reset Resets a VComments compiler. validate Validates the compiled lines. }

Methods inherited from SmartComments: compile, convertComment, parse, reset, validate

Methods inherited from Object: $, $<-, [[, [[<-, as.character, attach, attachLocally, clearCache, clearLookupCache, clone, detach, equals, extend, finalize, getEnvironment, getFieldModifier, getFieldModifiers, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, objectSize, print, save

bold

• Controls
• Enters and exits
• Simple output
• Output messages

cr

• • \#V=\#
  {[] - Sets the name of the object. Default is 'verbose'.} #V^#{ - setThreshold(, )} #V?#{ - if (isVisible()) { }} #V@#{ - setDefaultLevel(, )} #Vm#{ - (, )}
• • \#V+\#
  {[] - enter(, )} #V-#{[] - exit(, )} #V!#{[] - pushState() on.exit(popState()) If , enter(, )}
• • \#Vn\#
  { - newline()} #Vr#{ - ruler()} #Vt#{ - timestamp()} #Vw#{[
• • \#Vc\#
  {[] - cat(, )} #Ve#{ - eval(, )} #Vh#{ - header(, )} #Vp#{

Details

The 'v' in VComments stands for 'verbose', because of its relationship to the Verbose class.

Here is a list of VComments and the Rcode that replaces each of them by the compiler:

Constructors

• \#V0\#

{[] - NullVerbose()} #V1#{[] - Verbose()}

Examples

filename <- system.file("data-ex/exampleVComments.R", package="R.utils")
lines <- readLines(filename)

cat("Code before preprocessing:
")
displayCode(code=lines, pager="console")

lines <- VComments$compile(lines)

cat("Code after preprocessing:
")
displayCode(code=lines, pager="console")