print,asciiCbind-method {ascii}R Documentation

Print ascii object

Description

Function displaying the asciidoc, txt2tags, reStructuredText, org or textile code associated with the supplied object of class ascii.

Usage

## S4 method for signature 'asciiCbind'
print(
  x,
  type = getOption("asciiType"),
  file = NULL,
  append = FALSE,
  escape = FALSE,
  list.escape = c("\\_", "\\^"),
  ...
)

## S4 method for signature 'asciiCbind'
show(object)

## S4 method for signature 'asciiTable'
print(
  x,
  type = getOption("asciiType"),
  file = NULL,
  append = FALSE,
  escape = FALSE,
  list.escape = c("\\_", "\\^"),
  ...
)

## S4 method for signature 'asciiTable'
show(object)

## S4 method for signature 'asciiList'
print(
  x,
  type = getOption("asciiType"),
  file = NULL,
  append = FALSE,
  escape = FALSE,
  list.escape = c("\\_", "\\^"),
  ...
)

## S4 method for signature 'asciiList'
show(object)

## S4 method for signature 'asciiMixed'
print(
  x,
  type = getOption("asciiType"),
  file = NULL,
  append = FALSE,
  escape = FALSE,
  list.escape = c("\\_", "\\^"),
  ...
)

## S4 method for signature 'asciiMixed'
show(object)

## S4 method for signature 'Report'
print(x, help = FALSE, ...)

## S4 method for signature 'Report'
show(object)

Arguments

x

An object of class "asciiTable", "asciiList", "asciiMixed", "asciiCbind" or "Report".

type

Type of syntax produce. Possible values for type are "asciidoc", "t2t", "rest", "org", "textile" or "pandoc". Default value produce asciidoc syntax.

file

A character string naming the file to print to. Default is NULL (print to the console).

append

If TRUE, code will be appended to file instead of overwriting it. Default value is FALSE

escape

If TRUE, characters in list.escape will be be printed with a \. Default value is FALSE

list.escape

Character vector. Default value is c("\\_", "\\^")

...

Additional arguments. (Currently ignored.)

object

ascii or Report object

help

logical print help? (objects of class "Report")

Details

The package provides the new global option asciiType. Default value is "asciidoc" (see examples).

Author(s)

David Hajage dhajage@gmail.com

See Also

ascii

Examples

data(esoph)
ascii(esoph[1:10,])
print(ascii(esoph[1:10,]), type = "t2t")
print(ascii(esoph[1:10,]), type = "rest")
print(ascii(esoph[1:10,]), type = "org")
print(ascii(esoph[1:10,]), type = "textile")
print(ascii(esoph[1:10,]), type = "pandoc")
options(asciiType = "rest")
ascii(esoph[1:10,])
options(asciiType = "asciidoc")

[Package ascii version 2.6 Index]