ann: Add Leading Symbol Annotations

In trinker/pax: A Package Templating Package

Description

ann - Add leading symbol annotation (e.g., comment characters).

roxann - Add leading roxygen symbol annotation (i.e., #' ).

Usage

ann(object = "clipboard", symbol = "##", space = 1, copy2clip = TRUE,
  ...)

roxann(object = "clipboard", symbol = "#'", space = 1, copy2clip = TRUE,
  ...)

Arguments

object	An object to add commenting to. If "clipboard" copies from the clipboard.
symbol	The symbol(s) to use as the leading characters.
space	How many spaces to put between the symbol and the object lines.
copy2clip	logical, If TRUE the output is copied to the clipboard.
...	ignored.

Examples

## Not run: 
ann(mtcars)
roxann(mtcars)
ann(mtcars, symbol = "%%")  # LaTeX

library(clipr)
clipr::write_clip(capture.output(new_r))
ann()

## End(Not run)

trinker/pax documentation built on May 31, 2019, 9:42 p.m.