VComments

0th

Percentile

The VComments class

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

Keywords
classes, programming, IO
Usage
VComments(letter="V", verboseName="verbose", ...)
Arguments
letter
The smart letter.
verboseName
The name of the verbose object.
...
Not used.
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()}

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, clone, detach, equals, extend, finalize, gc, getEnvironment, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, objectSize, print, registerFinalizer, 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#{[] - warnings(<verbose>, <title>)}
    • \#Vc\#
    {[] - cat(, )} #Ve#{ - eval(, )} #Vh#{ - header(, )} #Vp#{ - print(, )} #Vs#{ - summary(, )} #Vz#{ - str(, )}

Aliases
  • VComments
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")
Documentation reproduced from package R.utils, version 1.6.0, License: LGPL (>= 2.1)

Community examples

Looks like there are no examples yet.