Sweave wrappers
Description
Sweave wrappers
Usage
Asciidoc(
file,
driver = RweaveAsciidoc,
syntax = SweaveSyntaxNoweb,
encoding = "",
...
)
T2t(file, driver = RweaveT2t, syntax = SweaveSyntaxNoweb, encoding = "", ...)
ReST(file, driver = RweaveReST, syntax = SweaveSyntaxNoweb, encoding = "", ...)
Org(file, driver = RweaveOrg, syntax = SweaveSyntaxNoweb, encoding = "", ...)
Textile(
file,
driver = RweaveTextile,
syntax = SweaveSyntaxNoweb,
encoding = "",
...
)
Pandoc(
file,
driver = RweavePandoc,
syntax = SweaveSyntaxNoweb,
encoding = "",
...
)
Arguments
file
Name of Sweave source file.
driver
Sweave driver
syntax
Sweave syntax
encoding
Encoding
...
Further arguments passed to the driver's setup function.
Author(s)
David Hajage dhajage@gmail.com
See Also
Examples
## Not run:
testfile <- system.file("examples", "Org-test-1.nw", package = "ascii")
## enforce par(ask = FALSE)
options(device.ask.default = FALSE)
## create an org file - in the current working directory, getwd():
Org(testfile)
Org(testfile, driver=weaverOrg)
## This can be edited in and exported from Org Mode
## End(Not run)
RtangleAscii
Description
RtangleAscii
Usage
RtangleAscii()
RtangleAsciiWritedoc
Description
RtangleAsciiWritedoc
Usage
RtangleAsciiWritedoc(object, chunk)
Arguments
object
object
chunk
chunk
RweaveAsciiFinish
Description
RweaveAsciiFinish
Usage
RweaveAsciiFinish(object, error = FALSE)
Arguments
object
object
error
error
RweaveAsciiOptions
Description
RweaveAsciiOptions
Usage
RweaveAsciiOptions(options)
Arguments
options
options
RweaveAsciiSetup
Description
RweaveAsciiSetup
Usage
RweaveAsciiSetup(
file,
syntax,
output = NULL,
quiet = FALSE,
debug = FALSE,
extension = "txt",
backend = "asciidoc",
openSchunk = "----",
closeSchunk = "\n----\n",
openSinput = "",
closeSinput = "",
openSoutput = "\n",
closeSoutput = "",
indent = "",
openInclude = "include::",
closeInclude = ".txt[]",
openFig = "image::",
closeFig = "[]",
...
)
Arguments
file
file
syntax
syntax
output
output
quiet
quite
debug
debug
...
...
RweaveAsciiWritedoc
Description
RweaveAsciiWritedoc
Usage
RweaveAsciiWritedoc(object, chunk)
Arguments
object
object
chunk
chunk
A driver to parse asciidoc noweb files with Sweave tool This driver parses asciidoc files containing R code and replace pieces of code with their output.
Description
A driver to parse asciidoc noweb files with Sweave tool This driver parses asciidoc files containing R code and replace pieces of code with their output.
weaverAsciidocSetup
weaverAsciidoc
Usage
RweaveAsciidoc()
weaverAsciiSetup(
file,
syntax,
output = NULL,
quiet = FALSE,
debug = FALSE,
extension = "txt",
backend = "asciidoc",
openSchunk = "----",
closeSchunk = "\n----\n",
openSinput = "",
closeSinput = "",
openSoutput = "\n",
closeSoutput = "",
indent = "",
openInclude = "include::",
closeInclude = ".txt[]",
openFig = "image::",
closeFig = "[]",
use.cache = TRUE,
...
)
weaverAsciidoc()
Arguments
use.cache
use.cache
Value
None value is returned. From a .Rnw noweb file, the corresponding .txt is produced (as eventuals files for graphs).
Note
In order to work properly, noweb codes have to be located at the beginning of a line (no indentation).
Compare with RweaveLatex driver, RweaveAsciidoc provides one new option :
format to choose the format of figure that will be inserted in the
final document.
In addition, cache option from weaver
package is also available with weaverAsciidoc driver.
A wrapper for Sweave can be used, named Asciidoc.
Author(s)
David Hajage dhajage@gmail.com
See Also
Examples
## Not run:
Asciidoc(system.file("examples/Asciidoc-test-1.nw",package="ascii"))
Asciidoc(system.file("examples/Asciidoc-test-1.nw",package="ascii"),weaverAsciidoc())
system("asciidoc Asciidoc-test-1.txt")
## End(Not run)
A driver to parse org noweb files with Sweave tool This driver parses org files containing R code and replace pieces of code with their output.
Description
A driver to parse org noweb files with Sweave tool This driver parses org files containing R code and replace pieces of code with their output.
RweaveOrgSetup
weaverOrgSetup
weaverOrg
Usage
RweaveOrg()
RweaveOrgSetup(
file,
syntax,
output = NULL,
quiet = FALSE,
debug = FALSE,
extension = "org",
backend = "org-mode",
openSchunk = "#+BEGIN_example",
closeSchunk = "\n#+END_example\n",
openSinput = "",
closeSinput = "",
openSoutput = "\n",
closeSoutput = "",
indent = "",
openInclude = "#+INCLUDE: \"",
closeInclude = ".org\"",
openFig = "[[file:",
closeFig = "]]",
...
)
weaverOrgSetup(
file,
syntax,
output = NULL,
quiet = FALSE,
debug = FALSE,
extension = "org",
backend = "org-mode",
openSchunk = "#+BEGIN_example",
closeSchunk = "\n#+END_example\n",
openSinput = "",
closeSinput = "",
openSoutput = "\n",
closeSoutput = "",
indent = "",
openInclude = "#+INCLUDE: \"",
closeInclude = ".org\"",
openFig = "[[file:",
closeFig = "]]",
use.cache = TRUE,
...
)
weaverOrg()
Arguments
file
file
syntax
syntax
output
output
quiet
quite
debug
debug
...
...
use.cache
use.cache
Value
None value is returned. From a .Rnw noweb file, the corresponding .org is produced (as eventuals files for graphs).
Note
In order to work properly, noweb codes have to be located at the beginning of a line (no indentation).
Compare with RweaveLatex driver, RweaveOrg provides one new option :
format to choose the format of figure that will be inserted in the
final document.
In addition, cache option from weaver
package is also available with weaverOrg driver.
A wrapper for Sweave can be used, named Org.
Author(s)
David Hajage dhajage@gmail.com
See Also
Examples
## Not run:
Org(system.file("examples/Org-test-1.nw",package="ascii"))
Org(system.file("examples/Org-test-1.nw",package="ascii"),weaverOrg())
## End(Not run)
A driver to parse Pandoc noweb files with Sweave tool This driver parses Pandoc files containing R code and replace pieces of code with their output.
Description
A driver to parse Pandoc noweb files with Sweave tool This driver parses Pandoc files containing R code and replace pieces of code with their output.
RweavePandocSetup
weaverPandocSetup
weaverPandoc
Usage
RweavePandoc()
RweavePandocSetup(
file,
syntax,
output = NULL,
quiet = FALSE,
debug = FALSE,
extension = "md",
backend = "pandoc",
openSchunk = "~~~~~~{.R}",
closeSchunk = "\n~~~~~~~~~~~\n\n",
openSinput = "",
closeSinput = "",
openSoutput = "\n",
closeSoutput = "",
indent = "",
openInclude = "",
closeInclude = "",
openFig = "![](",
closeFig = ")",
...
)
weaverPandocSetup(
file,
syntax,
output = NULL,
quiet = FALSE,
debug = FALSE,
extension = "md",
backend = "pandoc",
openSchunk = "~~~~~~{.R}",
closeSchunk = "\n~~~~~~~~~~~\n\n",
openSinput = "",
closeSinput = "",
openSoutput = "\n",
closeSoutput = "",
indent = "",
openInclude = "",
closeInclude = "",
openFig = "![](",
closeFig = ")",
use.cache = TRUE,
...
)
weaverPandoc()
Arguments
file
file
syntax
syntax
output
output
quiet
quite
debug
debug
...
...
use.cache
use.cache
Value
None value is returned. From a .Rnw noweb file, the corresponding .md is produced (as eventuals files for graphs).
Note
In order to work properly, noweb codes have to be located at the beginning of a line (no indentation).
Compare with RweaveLatex driver, RweavePandoc provides one new option :
format to choose the format of figure that will be inserted in the
final document.
In addition, cache option from weaver
package is also available with weaverPandoc driver.
A wrapper for Sweave can be used, named Pandoc.
Author(s)
David Hajage dhajage@gmail.com Matti Pastell matti.pastell@helsinki.fi
See Also
Examples
## Not run:
Pandoc("file.Rnw")
## End(Not run)
A driver to parse sphinx noweb files with Sweave tool This driver parses sphinx files containing R code and replace pieces of code with their output.
Description
A driver to parse sphinx noweb files with Sweave tool This driver parses sphinx files containing R code and replace pieces of code with their output.
RweaveReSTSetup
weaverReSTSetup
weaverReST
Usage
RweaveReST()
RweaveReSTSetup(
file,
syntax,
output = NULL,
quiet = FALSE,
debug = FALSE,
extension = "rst",
backend = "docutils, sphinx, ...",
openSchunk = "\n.. code-block:: r\n",
closeSchunk = "\n\n",
openSinput = "",
closeSinput = "",
openSoutput = "\n\n",
closeSoutput = "\n",
indent = " ",
openInclude = ".. include::",
closeInclude = ".rst",
openFig = ".. figure:: ",
closeFig = "",
...
)
weaverReSTSetup(
file,
syntax,
output = NULL,
quiet = FALSE,
debug = FALSE,
extension = "rst",
backend = "docutils, sphinx, ...",
openSchunk = "\n.. code-block:: r\n",
closeSchunk = "\n\n",
openSinput = "",
closeSinput = "",
openSoutput = "\n\n",
closeSoutput = "\n",
indent = " ",
openInclude = ".. include::",
closeInclude = ".rst",
openFig = ".. figure:: ",
closeFig = "",
use.cache = TRUE,
...
)
weaverReST()
Arguments
file
file
syntax
syntax
output
output
quiet
quite
debug
debug
...
...
use.cache
use.cache
Value
None value is returned. From a .Rnw noweb file, the corresponding .rst is produced (as eventuals files for graphs).
Note
In order to work properly, noweb codes have to be located at the beginning of a line (no indentation).
Compare with RweaveLatex driver, RweaveReST provides one new option :
format to choose the format of figure that will be inserted in the
final document.
In addition, cache option from weaver
package is also available with weaverReST driver.
A wrapper for Sweave can be used, named ReST.
Author(s)
David Hajage dhajage@gmail.com
See Also
Examples
## Not run:
ReST("file.Rnw")
## End(Not run)
A driver to parse txt2tags noweb files with Sweave tool This driver parses txt2tags files containing R code and replace pieces of code with their output.
Description
A driver to parse txt2tags noweb files with Sweave tool This driver parses txt2tags files containing R code and replace pieces of code with their output.
RweaveT2tSetup
weaverT2tSetup
weaverT2t
Usage
RweaveT2t()
RweaveT2tSetup(
file,
syntax,
output = NULL,
quiet = FALSE,
debug = FALSE,
extension = "t2t",
backend = "txt2tags",
openSchunk = "```",
closeSchunk = "\n```\n",
openSinput = "",
closeSinput = "",
openSoutput = "\n",
closeSoutput = "",
indent = "",
openInclude = "%!include: ",
closeInclude = ".t2t",
openFig = "[",
closeFig = "]",
...
)
weaverT2tSetup(
file,
syntax,
output = NULL,
quiet = FALSE,
debug = FALSE,
extension = "t2t",
backend = "txt2tags",
openSchunk = "```",
closeSchunk = "\n```\n",
openSinput = "",
closeSinput = "",
openSoutput = "\n",
closeSoutput = "",
indent = "",
openInclude = "%!include: ",
closeInclude = ".t2t",
openFig = "[",
closeFig = "]",
use.cache = TRUE,
...
)
weaverT2t()
Arguments
file
file
syntax
syntax
output
output
quiet
quite
debug
debug
...
...
use.cache
use.cache
Value
None value is returned. From a .Rnw noweb file, the corresponding .t2t is produced (as eventuals files for graphs).
Note
In order to work properly, noweb codes have to be located at the beginning of a line (no indentation).
Compare with RweaveLatex driver, RweaveT2t provides one new option :
format to choose the format of figure that will be inserted in the
final document.
In addition, cache option from weaver
package is also available with weaverT2t driver.
A wrapper for Sweave can be used, named T2t.
Author(s)
David Hajage dhajage@gmail.com
See Also
Examples
## Not run:
T2t("file.Rnw")
## End(Not run)
A driver to parse textile noweb files with Sweave tool This driver parses textile files containing R code and replace pieces of code with their output.
Description
A driver to parse textile noweb files with Sweave tool This driver parses textile files containing R code and replace pieces of code with their output.
RweaveTextileSetup
weaverTextileSetup
weaverTextile
Usage
RweaveTextile()
RweaveTextileSetup(
file,
syntax,
output = NULL,
quiet = FALSE,
debug = FALSE,
extension = "txt",
backend = "textile",
openSchunk = "\nbc.. ",
closeSchunk = "\n\np. \n\n",
openSinput = "",
closeSinput = "",
openSoutput = "\n",
closeSoutput = "",
indent = "",
openInclude = "",
closeInclude = "",
openFig = "!",
closeFig = "!",
...
)
weaverTextileSetup(
file,
syntax,
output = NULL,
quiet = FALSE,
debug = FALSE,
extension = "txt",
backend = "textile",
openSchunk = "\nbc.. ",
closeSchunk = "\n\np. \n\n",
openSinput = "",
closeSinput = "",
openSoutput = "\n",
closeSoutput = "",
indent = "",
openInclude = "",
closeInclude = "",
openFig = "!",
closeFig = "!",
use.cache = TRUE,
...
)
weaverTextile()
Arguments
file
file
syntax
syntax
output
output
quiet
quite
debug
debug
...
...
use.cache
use.cache
Value
None value is returned. From a .Rnw noweb file, the corresponding .txt is produced (as eventuals files for graphs).
Note
In order to work properly, noweb codes have to be located at the beginning of a line (no indentation).
Compare with RweaveLatex driver, RweaveTextile provides one new option :
format to choose the format of figure that will be inserted in the
final document.
In addition, cache option from weaver
package is also available with weaverTextile driver.
A wrapper for Sweave can be used, named Textile.
Author(s)
David Hajage dhajage@gmail.com
See Also
Examples
## Not run:
Textile("file.Rnw")
## End(Not run)
align.table
Description
align.table
Usage
align.table(x, align, space = 1)
Arguments
x
x
align
align
space
space
as.list.matrix
Description
as.list.matrix
Usage
## S3 method for class 'matrix'
as.list(x, byrow = TRUE, ...)
Arguments
x
x
byrow
byrow
...
...
Export R objects to several markup languages
Description
Convert an R object to an ascii object, which can then be
printed with asciidoc, txt2tags, reStructuredText, org, textile or
pandoc syntax.
Usage
## S3 method for class 'anova'
ascii(
x,
include.rownames = TRUE,
include.colnames = TRUE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = TRUE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
...
)
## S3 method for class 'data.frame'
ascii(
x,
include.rownames = TRUE,
include.colnames = TRUE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = TRUE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
...
)
## Default S3 method:
ascii(
x,
include.rownames = TRUE,
include.colnames = TRUE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = TRUE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
list.type = "bullet",
...
)
## S3 method for class 'glm'
ascii(
x,
include.rownames = TRUE,
include.colnames = TRUE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = TRUE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
...
)
## S3 method for class 'summary.glm'
ascii(
x,
include.rownames = TRUE,
include.colnames = TRUE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = TRUE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
...
)
## S3 method for class 'describe'
ascii(x, condense = TRUE, ...)
## S3 method for class 'summary.formula.response'
ascii(
x,
vnames = c("labels", "names"),
prUnits = TRUE,
lgroup = list(dimnames(stats)[[1]], if (ul) vlabels else at$vname[at$vname != ""]),
n.lgroup = list(1, at$nlevels),
include.rownames = FALSE,
include.colnames = TRUE,
format = "nice",
caption = paste(at$ylabel, if (ns > 1) paste(" by", if (ul) at$strat.label else
at$strat.name), " N = ", at$n, if (at$nmiss) paste(", ", at$nmiss, " Missing", sep =
""), sep = ""),
caption.level = "s",
header = TRUE,
...
)
## S3 method for class 'summary.formula.reverse'
ascii(
x,
digits,
prn = any(n != N),
pctdig = 0,
npct = c("numerator", "both", "denominator", "none"),
exclude1 = TRUE,
vnames = c("labels", "names"),
prUnits = TRUE,
sep = "/",
formatArgs = NULL,
round = NULL,
prtest = c("P", "stat", "df", "name"),
prmsd = FALSE,
pdig = 3,
eps = 0.001,
caption = paste("Descriptive Statistics", if (length(x$group.label)) paste(" by",
x$group.label) else paste(" (N = ", x$N, ")", sep = ""), sep = ""),
caption.level = "s",
include.rownames = FALSE,
include.colnames = TRUE,
colnames = gl,
header = TRUE,
lgroup = lgr,
n.lgroup = n.lgr,
rgroup = rgr,
n.rgroup = n.rgr,
rstyle = "d",
...
)
## S3 method for class 'summary.formula.cross'
ascii(
x,
twoway = nvar == 2,
prnmiss = any(stats$Missing > 0),
prn = TRUE,
formatArgs = NULL,
caption = a$heading,
caption.level = "s",
include.rownames = FALSE,
include.colnames = TRUE,
header = TRUE,
format = "nice",
lgroup = v,
n.lgroup = rep(length(z), length(v)),
...
)
## S3 method for class 'htest'
ascii(
x,
include.rownames = TRUE,
include.colnames = TRUE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = TRUE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
...
)
## S3 method for class 'list'
ascii(x, caption = NULL, caption.level = NULL, list.type = "bullet", ...)
## S3 method for class 'packageDescription'
ascii(x, caption = NULL, caption.level = NULL, list.type = "label", ...)
## S3 method for class 'sessionInfo'
ascii(x, locale = TRUE, ...)
## S3 method for class 'lm'
ascii(
x,
include.rownames = TRUE,
include.colnames = TRUE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = TRUE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
...
)
## S3 method for class 'summary.lm'
ascii(
x,
include.rownames = TRUE,
include.colnames = TRUE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = TRUE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
...
)
## S3 method for class 'matrix'
ascii(
x,
include.rownames = FALSE,
include.colnames = FALSE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = FALSE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
...
)
## S3 method for class 'survfit'
ascii(
x,
scale = 1,
print.rmean = getOption("survfit.print.rmean"),
rmean = getOption("survfit.rmean"),
include.rownames = TRUE,
include.colnames = TRUE,
header = TRUE,
...
)
## S3 method for class 'table'
ascii(
x,
include.rownames = TRUE,
include.colnames = TRUE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = TRUE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
...
)
## S3 method for class 'integer'
ascii(
x,
include.rownames = FALSE,
include.colnames = FALSE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = FALSE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
...
)
## S3 method for class 'numeric'
ascii(
x,
include.rownames = FALSE,
include.colnames = FALSE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = FALSE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
...
)
## S3 method for class 'character'
ascii(
x,
include.rownames = FALSE,
include.colnames = FALSE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = FALSE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
...
)
## S3 method for class 'factor'
ascii(
x,
include.rownames = FALSE,
include.colnames = FALSE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = FALSE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
...
)
## S3 method for class 'proc_time'
ascii(x, include.rownames = FALSE, include.colnames = TRUE, ...)
ascii(x, ...)
Arguments
x
An R object of class found among
methods(ascii). If x is a list, it should be a list
of character strings (it will produce a bulleted list output by
default).
include.rownames
logical. If TRUE the rows names are printed.
Default value depends of class of x.
include.colnames
logical. If TRUE the columns names are
printed. Default value depends of class of x.
rownames
Character vector (replicated or truncated as necessary)
indicating rownames of the corresponding rows. If NULL (default)
the row names are not modified
colnames
Character vector (replicated or truncated as necessary)
indicating colnames of the corresponding columns. If NULL
(default) the column names are not modified
format
Character vector or matrix indicating the format for the
corresponding columns. These values are passed to the formatC
function. Use "d" (for integers), "f", "e",
"E", "g", "G", "fg" (for reals), or
"s" (for strings). "f" gives numbers in the usual
xxx.xxx format; "e" and "E" give n.ddde+nn or
n.dddE+nn (scientific format); "g" and "G" put
x[i] into scientific format only if it saves space to do so.
"fg" uses fixed format as "f", but digits as number
of significant digits. Note that this can lead to quite long
result strings. Finaly, "nice" is like "f", but with 0
digits if x is an integer. Default depends on the class of
x.
digits
Numeric vector of length equal to the number of columns of
the resulting table (otherwise it will be replicated or truncated as
necessary) indicating the number of digits to display in the
corresponding columns. Default is 2.
decimal.mark
The character to be used to indicate the numeric
decimal point. Default is ".".
na.print
The character string specifying how NA should be
formatted specially. Default is "".
caption
Character vector of length 1 containing the table's caption
or title. Set to "" to suppress the caption. Default value is
NULL.
caption.level
Character or numeric vector of length 1 containing the
caption's level. Can take the following values: 0 to 5,
"." (block titles in asciidoc markup), "s" (strong),
"e" (emphasis), "m" (monospaced) or "" (no markup).
Default is NULL.
width
Numeric vector of length one containing the table width
relative to the available width (expressed as a percentage value,
1... 99). Default is 0 (all available width).
frame
Character vector of length one. Defines the table border, and
can take the following values: "topbot" (top and bottom),
"all" (all sides), "none" and "sides" (left and
right). The default value is NULL.
grid
Character vector of length one. Defines which ruler lines are
drawn between table rows and columns, and can take the following values:
"all", "rows", "cols" and "none". Default is
NULL.
valign
Vector or matrix indicating vertical alignment of all cells
in table. Can take the following values: "top", "bottom"
and "middle". Default is "".
header
logical or numeric. If TRUE or 1, 2,
..., the first line(s) of the table is (are) emphasized. The default
value depends of class of x.
footer
logical or numeric. If TRUE or 1, the last
line(s) of the table is (are) emphasized. The default value depends of
class of x.
align
Vector or matrix indicating the alignment of the corresponding
columns. Can be composed with "r" (right), "l" (left) and
"c" (center). Default value is NULL.
col.width
Numeric vector of length equal to the number of columns of
the resulting table (otherwise it will be replicated or truncated as
necessary) indicating width of the corresponding columns (integer
proportional values). Default is 1.
style
Character vector or matrix indicating the style of the
corresponding columns. Can be composed with "d" (default),
"s" (strong), "e" (emphasis), "m" (monospaced),
"h" (header) "a" (cells can contain any of the AsciiDoc
elements that are allowed inside document), "l" (literal),
"v" (verse; all line breaks are retained). Default is
NULL.
tgroup
Character vector or a list of character vectors defining
major top column headings. The default is to have none (NULL).
n.tgroup
A numeric vector or a list of numeric vectors containing
the number of columns for which each element in tgroup is a heading. For
example, specify tgroup=c("Major 1","Major 2"),
n.tgroup=c(3,3) if "Major 1" is to span columns 1-3 and
"Major 2" is to span columns 4-6.
talign
Character vector of length one defining alignment of major top column headings.
tvalign
Character vector of length one defining vertical alignment of major top column headings.
tstyle
Character vector of length one indicating the style of major top column headings
bgroup
Character vector or list of character vectors defining major
bottom column headings. The default is to have none (NULL).
n.bgroup
A numeric vector containing the number of columns for which each element in bgroup is a heading.
balign
Character vector of length one defining alignment of major bottom column headings.
bvalign
Character vector of length one defining vertical alignment of major bottom column headings.
bstyle
Character vector of length one indicating the style of major bottom column headings
lgroup
Character vector or list of character vectors defining major
left row headings. The default is to have none (NULL).
n.lgroup
A numeric vector containing the number of rows for which
each element in lgroup is a heading. Column names count in the row
numbers if include.colnames = TRUE.
lalign
Character vector of length one defining alignment of major left row headings.
lvalign
Character vector of length one defining vertical alignment of major left row headings.
lstyle
Character vector of length one indicating the style of major left row headings
rgroup
Character vector or list of character vectors defining major
right row headings. The default is to have none (NULL).
n.rgroup
A numeric vector containing the number of rows for which
each element in rgroup is a heading. Column names count in the row
numbers if include.colnames = TRUE.
ralign
Character vector of length one defining alignment of major right row headings.
rvalign
Character vector of length one defining vertical alignment of major right row headings.
rstyle
Character vector of length one indicating the style of major right row headings
...
Additional arguments. (Currently ignored.)
list.type
Character vector of length one indicating the list type
("bullet", "number", "label" or "none"). If
"label", names(list) is used for labels. Default is
"bullet".
condense
default is TRUE to condense the output with regard to the 5
lowest and highest values and the frequency table (describe() in
package Hmisc).
vnames
By default, tables and plots are usually labeled
with variable labels (see summary.formula in package
Hmisc).
prUnits
set to FALSE to suppress printing or latexing
units attributes of variables (see summary.formula in
package Hmisc).
prn
set to TRUE to print the number of non-missing
observations on the current (row) variable (see
summary.formula in package Hmisc).
pctdig
number of digits to the right of the decimal place
for printing percentages (see summary.formula in package
Hmisc).
npct
specifies which counts are to be printed to the right
of percentages (see summary.formula in package
Hmisc).
exclude1
by default, method="reverse" objects will be
printed, plotted, or typeset by removing redundant entries from
percentage tables for categorical variables (see
summary.formula in package Hmisc).
sep
character to use to separate quantiles when printing
method="reverse" tables (see summary.formula in package
Hmisc).
formatArgs
a list containing other arguments to pass to
format.default (see summary.formula in package
Hmisc).
round
Specify round to round the quantiles and
optional mean and standard deviation to round digits after
the decimal point (see summary.formula in package
Hmisc).
prtest
a vector of test statistic components to print if
test=TRUE (see summary.formula in package
Hmisc).
prmsd
set to TRUE to print mean and SD after the
three quantiles, for continuous variables (see
summary.formula in package Hmisc).
pdig
number of digits to the right of the decimal place for
printing P-values. (see summary.formula in package
Hmisc).
eps
P-values less than eps will be printed as
< eps (see summary.formula in package Hmisc).
twoway
controls whether the resulting table will be printed
in enumeration format or as a two-way table (the default) (see
summary.formula in package Hmisc).
prnmiss
set to FALSE to suppress printing counts of
missing values
locale
show locale information?
scale
A numeric value to rescale the survival time, e.g., if the
input data to survfit were in days, scale=365 would scale the
printout to years (see print.survfit() in package
survival).
print.rmean
Option for computation and display of the restricted mean (see print.survfit() in package survival).
rmean
Option for computation and display of the restricted mean (see print.survfit() in package survival).
Details
The nature of the generated output depends on the class of
x. For example, summary.table objects produce a
bulleted list while data.frame objects produce a table of
the entire data.frame.
Sometimes, arguments are not active, depending of the features implemented in the markup language generated. All arguments are active when asciidoc syntax is produced.
The available method functions for ascii are given by
methods(ascii). Users can extend the list of available
classes by writing methods for the generic function ascii.
All method functions should return an object of class
"ascii".
Value
This function returns an object of class
"asciiTable", "asciiList" or "asciiMixed".
Author(s)
David Hajage dhajage@gmail.com
Examples
op <- options(asciiType = "org")
local({x <- 1:10; y <- rnorm(length(x),1+x); ascii(anova(lm(y~x)))})
options(op)
op <- options(asciiType = "org")
ascii(data.frame(a = 1:3, b = 2), include.rownames = FALSE, digits = 0)
options(op)
op <- options(asciiType = "org")
local({x <- 1:10; y <- rnorm(length(x), 1+x); ascii(glm(y~x)) })
options(op)
op <- options(asciiType = "org")
local({x <- 1:10; y <- rnorm(length(x), 1+x); ascii(summary(glm(y~x))) })
options(op)
op <- options(asciiType = "org")
local({x <- rnorm(100); ascii(t.test(x))})
options(op)
op <- options(asciiType = "org")
ascii(list(a=1,b=2), list.type="label")
options(op)
op <- options(asciiType = "org")
ascii(sessionInfo())
options(op)
op <- options(asciiType = "org")
local({x <- 1:10; y <- rnorm(length(x), 1+x); ascii(lm(y~x)) })
options(op)
op <- options(asciiType = "org")
local({x <- 1:10; y <- rnorm(length(x), 1+x); ascii(summary(lm(y~x))) })
options(op)
op <- options(asciiType = "org")
ascii(matrix(1:4,2,2,FALSE,list(1:2,c("A","B"))), TRUE, TRUE, digits=0)
options(op)
op <- options(asciiType = "org")
ascii(table(rbinom(100,5,.3)), digits=0)
options(op)
op <- options(asciiType = "org")
ascii(c(a=1L,b=2L),FALSE,TRUE,digits=0)
options(op)
op <- options(asciiType = "org")
ascii(seq(0,1,length=11),digits=1)
options(op)
op <- options(asciiType = "org")
ascii(c(a="A",b="B"),FALSE,TRUE,header=TRUE)
options(op)
op <- options(asciiType = "org")
ascii(factor(c("A","B")),FALSE)
options(op)
op <- options(asciiType = "org")
ascii(system.time(sum(1:1e6)), header=TRUE)
options(op)
data(esoph)
ascii(esoph[1:10,])
tab <- table(esoph$agegp, esoph$alcgp)
ascii(tab)
print(ascii(tab), type = "t2t")
print(ascii(tab), type = "rest")
print(ascii(tab), type = "org")
ascii(summary(tab))
Ascii formatting for a microbenchmark
Description
The default implementation returns an asciiMixed object with the units for the first element.
Usage
## S3 method for class 'microbenchmark'
ascii(x, unit, order, signif, row.names = FALSE, caption = NULL, ...)
Arguments
x
an object of class 'microbenchmark'
unit
What unit to print the timings in. Default value taken from the option 'microbenchmark.unit'
order
If present, order results according to this column of the output.
signif
If present, limit the limit of significant digits shown.
row.names
Argument passed to ascii
caption
logical; if not NULL, then add caption with units specified; otherwise, add units as part of an asciiMixed object.
...
Other parameters to pass to ascii for the summary table
Value
ascii object
ascii table generator
Description
ascii table generator
Author(s)
David Hajage
Translation of the printCoefmat function for ascii
Description
Compared with printCoefmat, this drops the quote and right arguments, and adds include.rownames, include.colnames and header default arguments.
Usage
asciiCoefmat(
x,
digits = max(3L, getOption("digits") - 2L),
signif.stars = getOption("show.signif.stars"),
signif.legend = signif.stars,
dig.tst = max(1L, min(5L, digits - 1L)),
cs.ind = 1:k,
tst.ind = k + 1,
zap.ind = integer(),
P.values = NULL,
has.Pvalue = nc >= 4L && length(cn <- colnames(x)) && substr(cn[nc], 1L, 3L) %in%
c("Pr(", "p-v"),
eps.Pvalue = .Machine$double.eps,
na.print = "NA",
include.rownames = TRUE,
include.colnames = TRUE,
header = TRUE,
...
)
Arguments
x
coefficient summary table that is suitable for printCoefmat
digits
minimum number of significant digits to be used for most numbers.
signif.stars
locial; if 'TRUE', P-values are additionally encoded visually as 'significance stars' in order to help scanning of long coefficient tables. It defaults to the 'show.signif.stars' slot of 'options'.
signif.legend
logical; if 'TRUE', a legend for the 'significance stars' is printed provided 'signif.stars = TRUE'.
dig.tst
minimum number of significant digits for the test statistics, see 'tst.ind'.
cs.ind
indices (integer) of column numbers which are (like) *c*oefficients and *s*tandard errors to be formatted together.
tst.ind
indices (integer) of column numbers for test statistics.
zap.ind
indices (integer) of column numbers which should be formatted by zapsmall, i.e., by 'zapping' values close to 0.
P.values
logical or 'NULL'; if 'TRUE', the last column of 'x' is formatted by format.pval as P values. If 'P.values = NULL', the default, it is set to 'TRUE' only if 'options("show.coef.Pvalue")' is 'TRUE' _and_ 'x' has at least 4 columns _and_ the last column name of 'x' starts with '"Pr("'.
has.Pvalue
logical; if 'TRUE', the last column of 'x' contains P values; in that case, it is printed if and only if 'P.values' (above) is true.
eps.Pvalue
lower threshold for reporting p-values.
na.print
a character string to code NA values in printed output.
include.rownames
argument passed to ascii
include.colnames
argument passed to ascii
header
argument passed to ascii
...
other argments passed to ascii
Value
ascii object. This is character, rather than numeric.
ascii list generator
Description
ascii list generator
Methods
show.asciidoc( x = .self$x, caption = .self$caption, caption.level = .self$caption.level, list.type = .self$list.type )print a list with asciidoc markup
show.org( x = .self$x, caption = .self$caption, caption.level = .self$caption.level, list.type = .self$list.type )print a list with org markup
show.pandoc( x = .self$x, caption = .self$caption, caption.level = .self$caption.level, list.type = .self$list.type )print a list with pandoc markup
show.rest( x = .self$x, caption = .self$caption, caption.level = .self$caption.level, list.type = .self$list.type )print a list with rest markup
show.t2t( x = .self$x, caption = .self$caption, caption.level = .self$caption.level, list.type = .self$list.type )print a list with t2t markup
show.textile( x = .self$x, caption = .self$caption, caption.level = .self$caption.level, list.type = .self$list.type )print a list with textile markup
Author(s)
David Hajage
ascii mixed generator
Description
ascii mixed generator
Methods
show.asciidoc()print everything with asciidoc markup
show.org()print everything with org markup
show.pandoc()print everything with pandoc markup
show.rest()print everything with rest markup
show.t2t()print everything with t2t markup
show.textile()print everything with textile markup
Author(s)
David Hajage
asciiOptions
Description
asciiOptions
Usage
asciiOpts(
select = "all",
.backends = NULL,
.outputs = NULL,
.extensions = NULL,
.cli = NULL,
.args = NULL,
.O = NULL,
.f = NULL,
.e = NULL,
.preambule = NULL
)
Arguments
select
select
.backends
.backends
.outputs
.outputs
.extensions
.extensions
.cli
.cli
.args
.args
.O
.O
.f
.f
.e
.e
.preambule
.preambule
Value
options
Author(s)
David.hajage
ascii table generator
Description
ascii table generator
Methods
show.asciidoc( x = .self$x, include.rownames = .self$include.rownames, include.colnames = .self$include.colnames, rownames = .self$rownames, colnames = .self$colnames, format = .self$format, digits = .self$digits, decimal.mark = .self$decimal.mark, na.print = .self$na.print, caption = .self$caption, caption.level = .self$caption.level, width = .self$width, frame = .self$frame, grid = .self$grid, valign = .self$valign, header = .self$header, footer = .self$footer, align = .self$align, col.width = .self$col.width, style = .self$style, lgroup = .self$lgroup, n.lgroup = .self$n.lgroup, lalign = .self$lalign, lvalign = .self$lvalign, lstyle = .self$lstyle, rgroup = .self$rgroup, n.rgroup = .self$n.rgroup, ralign = .self$ralign, rvalign = .self$rvalign, rstyle = .self$rstyle, tgroup = .self$tgroup, n.tgroup = .self$n.tgroup, talign = .self$talign, tvalign = .self$tvalign, tstyle = .self$tstyle, bgroup = .self$bgroup, n.bgroup = .self$n.bgroup, balign = .self$balign, bvalign = .self$bvalign, bstyle = .self$bstyle )print a table with asciidoc markup
show.org( x = .self$x, include.rownames = .self$include.rownames, include.colnames = .self$include.colnames, rownames = .self$rownames, colnames = .self$colnames, format = .self$format, digits = .self$digits, decimal.mark = .self$decimal.mark, na.print = .self$na.print, caption = .self$caption, caption.level = .self$caption.level, width = .self$width, frame = .self$frame, grid = .self$grid, valign = .self$valign, header = .self$header, footer = .self$footer, align = .self$align, col.width = .self$col.width, style = .self$style, lgroup = .self$lgroup, n.lgroup = .self$n.lgroup, lalign = .self$lalign, lvalign = .self$lvalign, lstyle = .self$lstyle, rgroup = .self$rgroup, n.rgroup = .self$n.rgroup, ralign = .self$ralign, rvalign = .self$rvalign, rstyle = .self$rstyle, tgroup = .self$tgroup, n.tgroup = .self$n.tgroup, talign = .self$talign, tvalign = .self$tvalign, tstyle = .self$tstyle, bgroup = .self$bgroup, n.bgroup = .self$n.bgroup, balign = .self$balign, bvalign = .self$bvalign, bstyle = .self$bstyle )print a table with org-mode markup
show.pandoc( x = .self$x, include.rownames = .self$include.rownames, include.colnames = .self$include.colnames, rownames = .self$rownames, colnames = .self$colnames, format = .self$format, digits = .self$digits, decimal.mark = .self$decimal.mark, na.print = .self$na.print, caption = .self$caption, caption.level = .self$caption.level, width = .self$width, frame = .self$frame, grid = .self$grid, valign = .self$valign, header = .self$header, footer = .self$footer, align = .self$align, col.width = .self$col.width, style = .self$style, lgroup = .self$lgroup, n.lgroup = .self$n.lgroup, lalign = .self$lalign, lvalign = .self$lvalign, lstyle = .self$lstyle, rgroup = .self$rgroup, n.rgroup = .self$n.rgroup, ralign = .self$ralign, rvalign = .self$rvalign, rstyle = .self$rstyle, tgroup = .self$tgroup, n.tgroup = .self$n.tgroup, talign = .self$talign, tvalign = .self$tvalign, tstyle = .self$tstyle, bgroup = .self$bgroup, n.bgroup = .self$n.bgroup, balign = .self$balign, bvalign = .self$bvalign, bstyle = .self$bstyle )print a table with pandoc markup
show.rest( x = .self$x, include.rownames = .self$include.rownames, include.colnames = .self$include.colnames, rownames = .self$rownames, colnames = .self$colnames, format = .self$format, digits = .self$digits, decimal.mark = .self$decimal.mark, na.print = .self$na.print, caption = .self$caption, caption.level = .self$caption.level, width = .self$width, frame = .self$frame, grid = .self$grid, valign = .self$valign, header = .self$header, footer = .self$footer, align = .self$align, col.width = .self$col.width, style = .self$style, lgroup = .self$lgroup, n.lgroup = .self$n.lgroup, lalign = .self$lalign, lvalign = .self$lvalign, lstyle = .self$lstyle, rgroup = .self$rgroup, n.rgroup = .self$n.rgroup, ralign = .self$ralign, rvalign = .self$rvalign, rstyle = .self$rstyle, tgroup = .self$tgroup, n.tgroup = .self$n.tgroup, talign = .self$talign, tvalign = .self$tvalign, tstyle = .self$tstyle, bgroup = .self$bgroup, n.bgroup = .self$n.bgroup, balign = .self$balign, bvalign = .self$bvalign, bstyle = .self$bstyle )print a table with restructuredText markup
show.t2t( x = .self$x, include.rownames = .self$include.rownames, include.colnames = .self$include.colnames, rownames = .self$rownames, colnames = .self$colnames, format = .self$format, digits = .self$digits, decimal.mark = .self$decimal.mark, na.print = .self$na.print, caption = .self$caption, caption.level = .self$caption.level, width = .self$width, frame = .self$frame, grid = .self$grid, valign = .self$valign, header = .self$header, footer = .self$footer, align = .self$align, col.width = .self$col.width, style = .self$style, lgroup = .self$lgroup, n.lgroup = .self$n.lgroup, lalign = .self$lalign, lvalign = .self$lvalign, lstyle = .self$lstyle, rgroup = .self$rgroup, n.rgroup = .self$n.rgroup, ralign = .self$ralign, rvalign = .self$rvalign, rstyle = .self$rstyle, tgroup = .self$tgroup, n.tgroup = .self$n.tgroup, talign = .self$talign, tvalign = .self$tvalign, tstyle = .self$tstyle, bgroup = .self$bgroup, n.bgroup = .self$n.bgroup, balign = .self$balign, bvalign = .self$bvalign, bstyle = .self$bstyle )print a table with txt2tags markup
show.textile( x = .self$x, include.rownames = .self$include.rownames, include.colnames = .self$include.colnames, rownames = .self$rownames, colnames = .self$colnames, format = .self$format, digits = .self$digits, decimal.mark = .self$decimal.mark, na.print = .self$na.print, caption = .self$caption, caption.level = .self$caption.level, width = .self$width, frame = .self$frame, grid = .self$grid, valign = .self$valign, header = .self$header, footer = .self$footer, align = .self$align, col.width = .self$col.width, style = .self$style, lgroup = .self$lgroup, n.lgroup = .self$n.lgroup, lalign = .self$lalign, lvalign = .self$lvalign, lstyle = .self$lstyle, rgroup = .self$rgroup, n.rgroup = .self$n.rgroup, ralign = .self$ralign, rvalign = .self$rvalign, rstyle = .self$rstyle, tgroup = .self$tgroup, n.tgroup = .self$n.tgroup, talign = .self$talign, tvalign = .self$tvalign, tstyle = .self$tstyle, bgroup = .self$bgroup, n.bgroup = .self$n.bgroup, balign = .self$balign, bvalign = .self$bvalign, bstyle = .self$bstyle )print a table with textile markup
Author(s)
David Hajage
beauty.asciidoc
Description
beauty.asciidoc
Usage
beauty.asciidoc(x, beauti = c("e", "m", "s"))
Arguments
x
x
beauti
beauti
beauty.org
Description
beauty.org
Usage
beauty.org(x, beauti = c("e", "m", "s"))
Arguments
x
x
beauti
beauti
beauty.pandoc
Description
beauty.pandoc
Usage
beauty.pandoc(x, beauti = c("e", "m", "s"))
Arguments
x
x
beauti
beauti
beauty.rest
Description
beauty.rest
Usage
beauty.rest(x, beauti = c("e", "m", "s"))
Arguments
x
x
beauti
beauti
beauty.t2t
Description
beauty.t2t
Usage
beauty.t2t(x, beauti = c("e", "m", "s"))
Arguments
x
x
beauti
beauti
beauty.textile
Description
beauty.textile
Usage
beauty.textile(x, beauti = c("e", "m", "s"))
Arguments
x
x
beauti
beauti
Cbind two ascii objects
Description
Cbind two ascii objects
Usage
## S3 method for class 'ascii'
cbind(
...,
caption = NULL,
caption.level = NULL,
frame = NULL,
grid = NULL,
col.width = 1,
width = 0
)
Arguments
...
ascii objects
caption
see ?ascii
caption.level
see ?ascii
frame
see ?ascii
grid
see ?ascii
col.width
see ?ascii
width
see ?ascii
Details
This function binds cols of two ascii table.
Value
An "asciiCbind" object.
Author(s)
David Hajage
Convert a file with specified backend
Description
Convert a file with specified backend
Usage
convert(
i,
d = NULL,
f = NULL,
e = NULL,
O = NULL,
backend = getOption("asciiBackend"),
cygwin = FALSE,
open = FALSE
)
Arguments
i
input file
d
output directory
f
format
e
encoding
O
other options
backend
backend ("asciidoc", "t2t" or "pandoc")
cygwin
use cygwin?
open
open resulting file?
Details
This function convert a file with asciidoc, txt2tags or pandoc backend
Value
Nothing
Author(s)
David Hajage
Report creation
Description
Produce a report
Usage
createreport(
...,
list = NULL,
file = NULL,
format = NULL,
open = TRUE,
backend = getOption("asciiBackend"),
encoding = NULL,
options = NULL,
cygwin = FALSE,
title = NULL,
author = NULL,
email = NULL,
date = NULL
)
Arguments
...
R objects (not used if "list" is not NULL)
list
list of R objects
file
name of the output file (without extension)
format
format of the output file
open
open resulting file?
backend
backend
encoding
encoding
options
other options
cygwin
use cygwin?
title
title of the report
author
author of the report
email
email of the author
date
date
Details
Produce a report from a list of R objects. This function can be
used directly, or through a Report object (see
examples). Report$new() creates a new object,
Report$create() produce a report. Exportation options can
be specified with Report$nameoftheoption <- option or
directly in Report$create(nameoftheoption = option).
Special objects can be used to create sections (see
?section), paragraphs (see ?paragraph), verbatim
environment (see ?verbatim and to insert figures (see
?fig) or inline results (see ?sexpr). Helpers exist:
Report$addSection(), Report$addParagraph(),
Report$addVerbatim(), Report$addFig().
It needs a working installation of asciidoc, a2x tool chain, txt2tags and/or pandoc (NB: markdown2pdf uses pandoc with latex).
Value
Nothing
Author(s)
David Hajage
Examples
## Not run:
op <- options(asciiType = "asciidoc")
createreport(head(esoph))
r <- Report$new(author = "David Hajage", email = "dhajage at gmail dot com")
r$add(section("First section"))
r$addSection("First subsection", 2)
r$add(paragraph("The data set has", sexpr(nrow(esoph)), " lines. See yourself:"), esoph)
r$addSection("Second subsection: age and alc group", 2)
tab <- with(esoph, table(alcgp, agegp))
r$add(ascii(tab), ascii(summary(tab), format = "nice"))
r$create()
r$format <- "slidy"
r$create()
r$title <- "R report example"
r$author <- "David Hajage"
r$email <- "dhajage at gmail dot com"
options(asciiType = "pandoc")
r$backend <- "pandoc"
r$format <- "odt"
r$create()
r$create(backend = "markdown2pdf", format = "pdf")
options(op)
## End(Not run)
div
Description
div
Usage
div(x, n = 2)
Arguments
x
x
n
n
escape.asciidoc
Description
escape.asciidoc
Usage
escape.asciidoc(x)
Arguments
x
x
escape.org
Description
escape.org
Usage
escape.org(x)
Arguments
x
x
escape.pandoc
Description
escape.pandoc
Usage
escape.pandoc(x)
Arguments
x
x
escape.rest
Description
escape.rest
Usage
escape.rest(x)
Arguments
x
x
escape.t2t
Description
escape.t2t
Usage
escape.t2t(x)
Arguments
x
x
escape.textile
Description
escape.textile
Usage
escape.textile(x)
Arguments
x
x
expand
Description
expand
Usage
expand(x, nrow, ncol, what = NULL, drop = TRUE)
Arguments
x
x
nrow
nrow
ncol
ncol
what
what
drop
drop
Insert figure
Description
graph can be used with export function to insert an R graphic.
Usage
fig(file = NULL, graph = NULL, format = NULL, ...)
Arguments
file
character string (
graph
a recordedplot, a lattice plot, a ggplot, or an expression producing a plot (optional if the file already exists)
format
jpg, png or pdf (or guessed with the file name)
...
additional arguments (passed to format options)
Value
A fig object
Author(s)
David Hajage
formatCustom
Description
formatCustom
Usage
formatCustom(x, format = "nice", digits = 2, ...)
Arguments
x
x
format
format
digits
digits
...
...
groups
Description
groups
Usage
groups(groups, n.groups = NULL, n)
Arguments
groups
groups
n.groups
n.groups
n
header.asciidoc
Description
header.asciidoc
Usage
header.asciidoc(
caption = NULL,
caption.level = NULL,
frame = NULL,
grid = NULL,
col.width = 1,
width = 0
)
Arguments
caption
caption
caption.level
caption.level
frame
frame
grid
grid
col.width
col.width
width
width
header.org
Description
header.org
Usage
header.org(caption = NULL, caption.level = NULL)
Arguments
caption
caption
caption.level
caption.level
header.pandoc
Description
header.pandoc
Usage
header.pandoc(caption = NULL, caption.level = NULL)
Arguments
caption
caption
caption.level
caption.level
header.rest
Description
header.rest
Usage
header.rest(caption = NULL, caption.level = NULL)
Arguments
caption
caption
caption.level
caption.level
header.t2t
Description
header.t2t
Usage
header.t2t(caption = NULL, caption.level = "")
Arguments
caption
caption
caption.level
caption.level
header.textile
Description
header.textile
Usage
header.textile(caption = NULL, caption.level = NULL, frame = NULL, width = 0)
Arguments
caption
caption
caption.level
caption.level
frame
frame
width
width
interleave
Description
interleave
Usage
interleave(...)
Arguments
...
...
interleave.data.frame
Description
interleave.data.frame
Usage
interleave.data.frame(..., byrow = TRUE, pretty.rownames = TRUE)
Arguments
...
...
byrow
byrow
pretty.rownames
pretty.rownames
interleave.matrix
Description
interleave.matrix
Usage
interleave.matrix(..., byrow = TRUE)
Arguments
...
...
byrow
byrow
linegroup
Description
linegroup
Usage
linegroup(group, n.group)
Arguments
group
group
n.group
n.group
makeRweaveAsciiCodeRunner
Description
makeRweaveAsciiCodeRunner
Usage
makeRweaveAsciiCodeRunner(evalFunc = RweaveEvalWithOpt)
Arguments
evalFunc
evalFunc
ngroups
Description
ngroups
Usage
ngroups(group, n.group = NULL, n)
Arguments
group
group
n.group
n.group
n
n
Export R objects
Description
out can be used with export function to insert an R results
Usage
out(x, results = "verbatim")
Arguments
x
an R object
results
if 'verbatim', the output is included in a verbatim environment. If 'ascii', the output is taken to be already proper markup and included as is.
Value
An out object
Author(s)
David Hajage
Create a paragraph
Description
paragraph can be used with export function to add... a paragraph
Usage
paragraph(..., new = TRUE)
Arguments
...
strings composing the paragraph
new
whether to create a new paragraph or to continue a preceding one
Value
A paragraph object.
Author(s)
David Hajage
paste.matrix
Description
paste.matrix
Usage
paste.matrix(
...,
sep = " ",
transpose.vector = FALSE,
collapse = NULL,
byrow = FALSE
)
Arguments
...
...
sep
sep
transpose.vector
transpose.vector
collapse
collapse
byrow
byrow
format p values
Description
format p values
Usage
plim(p, digits = 4)
Arguments
p
p values
digits
number of digits
Value
formated p values
Author(s)
David Hajage
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
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")
print.character.matrix
Description
print.character.matrix
Usage
## S3 method for class 'character.matrix'
print(
x,
vsep = "|",
before_vsep = "",
after_vsep = "",
hsep = "-",
csep = "+",
before_cell_content = " ",
after_cell_content = " ",
line_separator = TRUE,
line_separator_pos = NULL,
justify = "l",
space = 0,
right_alignment = FALSE,
print = TRUE
)
Arguments
x
x
vsep
vsep
before_vsep
before_vsep
after_vsep
after_vsep
hsep
hsep
csep
csep
before_cell_content
before_cell_content
after_cell_content
after_cell_content
line_separator
line_separator
line_separator_pos
line_separator_pos
justify
justify
right_alignment
right_alignment
print
Print an graph object
Description
Print an graph object
Usage
## S3 method for class 'fig'
print(x, backend = getOption("asciiBackend"), ...)
Arguments
x
an graph object
backend
ascii backend
...
not used
Author(s)
David Hajage
Print an out object
Description
Print an out object
Usage
## S3 method for class 'out'
print(x, backend = getOption("asciiBackend"), ...)
Arguments
x
an out object
backend
ascii backend
...
not used
Author(s)
David Hajage
Print a paragraph object
Description
Print a paragraph object
Usage
## S3 method for class 'paragraph'
print(x, ...)
Arguments
x
a paragraph object
...
not used
Author(s)
David Hajage
Print a section object
Description
Print a section object
Usage
## S3 method for class 'section'
print(x, backend = getOption("asciiBackend"), ...)
Arguments
x
a section object
backend
ascii backend
...
not used
Author(s)
David Hajage
Print a sexpr object
Description
Print a sexpr object
Usage
## S3 method for class 'sexpr'
print(x, ...)
Arguments
x
a sexpr object
...
not used
Author(s)
David Hajage
Print a verbatim object
Description
Print a verbatim object
Usage
## S3 method for class 'verbatim'
print(x, backend = getOption("asciiBackend"), ...)
Arguments
x
a verbatim object
backend
ascii backend
...
not used
Author(s)
David Hajage
repchar
Description
repchar
Usage
repchar(x, times = 1)
Arguments
x
x
times
times
replace
Description
replace
Usage
replace(
backend = getOption("asciiBackend"),
cygwin = FALSE,
i,
f = NULL,
d = NULL,
e = NULL,
O = NULL
)
Arguments
backend
backend
cygwin
cygwin
i
i
f
f
d
d
e
e
O
O
Author(s)
David Hajage
safe.as.character
Description
safe.as.character
Usage
safe.as.character(x)
Arguments
x
x
Create a section
Description
section can be used with export function to add... a section
Usage
section(caption, caption.level = 1)
Arguments
caption
a string
caption.level
caption level
Value
A section object.
Author(s)
David Hajage
Insert an inline R result
Description
sexpr can be used with export function to insert an inline R results
Usage
sexpr(x)
Arguments
x
an R results (of length one)
Value
A sexpr object.
Author(s)
David Hajage
show.asciidoc.list
Description
show.asciidoc.list
Usage
show.asciidoc.list(
x,
caption = NULL,
caption.level = NULL,
list.type = "bullet",
...
)
Arguments
x
x
caption
caption
caption.level
caption.level
list.type
list.type
...
...
show.asciidoc.table
Description
show.asciidoc.table
Usage
show.asciidoc.table(
x,
include.rownames = FALSE,
include.colnames = FALSE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = FALSE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
...
)
Arguments
x
x
include.rownames
include.rownames
include.colnames
include.colnames
rownames
rownames
colnames
colnames
format
format
digits
digits
decimal.mark
decimal.mark
na.print
na.print
caption
caption
caption.level
width
width
frame
frame
grid
grid
valign
valign
header
header
footer
footer
align
align
col.width
col.width
style
style
lgroup
lgroup
n.lgroup
n.lgroup
lalign
lalign
lvalign
lvalign
lstyle
lstyle
rgroup
rgroup
n.rgroup
n.rgroup
ralign
ralign
rvalign
rvalign
rstyle
rstyle
tgroup
tgroup
n.tgroup
n.tgroup
talign
talign
tvalign
tvalign
tstyle
tstyle
bgroup
bgroup
n.bgroup
n.bgroup
balign
balign
bvalign
bvalign
bstyle
bstyle
...
...
show.org.list
Description
show.org.list
Usage
show.org.list(
x,
caption = NULL,
caption.level = NULL,
list.type = "bullet",
...
)
Arguments
x
x
caption
caption
caption.level
caption.level
list.type
list.type
...
...
show.org.table
Description
show.org.table
Usage
show.org.table(
x,
include.rownames = FALSE,
include.colnames = FALSE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = FALSE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
...
)
Arguments
x
x
include.rownames
include.rownames
include.colnames
include.colnames
rownames
rownames
colnames
colnames
format
format
digits
digits
decimal.mark
decimal.mark
na.print
na.print
caption
caption
caption.level
width
width
frame
frame
grid
grid
valign
valign
header
header
footer
footer
align
align
col.width
col.width
style
style
lgroup
lgroup
n.lgroup
n.lgroup
lalign
lalign
lvalign
lvalign
lstyle
lstyle
rgroup
rgroup
n.rgroup
n.rgroup
ralign
ralign
rvalign
rvalign
rstyle
rstyle
tgroup
tgroup
n.tgroup
n.tgroup
talign
talign
tvalign
tvalign
tstyle
tstyle
bgroup
bgroup
n.bgroup
n.bgroup
balign
balign
bvalign
bvalign
bstyle
bstyle
...
...
show.pandoc.list
Description
show.pandoc.list
Usage
show.pandoc.list(
x,
caption = NULL,
caption.level = NULL,
list.type = "bullet",
...
)
Arguments
x
x
caption
caption
caption.level
caption.level
list.type
list.type
...
...
show.pandoc.table
Description
show.pandoc.table
Usage
show.pandoc.table(
x,
include.rownames = FALSE,
include.colnames = FALSE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = FALSE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
...
)
Arguments
x
x
include.rownames
include.rownames
include.colnames
include.colnames
rownames
rownames
colnames
colnames
format
format
digits
digits
decimal.mark
decimal.mark
na.print
na.print
caption
caption
caption.level
width
width
frame
frame
grid
grid
valign
valign
header
header
footer
footer
align
align
col.width
col.width
style
style
lgroup
lgroup
n.lgroup
n.lgroup
lalign
lalign
lvalign
lvalign
lstyle
lstyle
rgroup
rgroup
n.rgroup
n.rgroup
ralign
ralign
rvalign
rvalign
rstyle
rstyle
tgroup
tgroup
n.tgroup
n.tgroup
talign
talign
tvalign
tvalign
tstyle
tstyle
bgroup
bgroup
n.bgroup
n.bgroup
balign
balign
bvalign
bvalign
bstyle
bstyle
...
...
show.rest.list
Description
show.rest.list
Usage
show.rest.list(
x,
caption = NULL,
caption.level = NULL,
list.type = "bullet",
...
)
Arguments
x
x
caption
caption
caption.level
caption.level
list.type
list.type
...
...
show.rest.table
Description
show.rest.table
Usage
show.rest.table(
x,
include.rownames = FALSE,
include.colnames = FALSE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = FALSE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
...
)
Arguments
x
x
include.rownames
include.rownames
include.colnames
include.colnames
rownames
rownames
colnames
colnames
format
format
digits
digits
decimal.mark
decimal.mark
na.print
na.print
caption
caption
caption.level
width
width
frame
frame
grid
grid
valign
valign
header
header
footer
footer
align
align
col.width
col.width
style
style
lgroup
lgroup
n.lgroup
n.lgroup
lalign
lalign
lvalign
lvalign
lstyle
lstyle
rgroup
rgroup
n.rgroup
n.rgroup
ralign
ralign
rvalign
rvalign
rstyle
rstyle
tgroup
tgroup
n.tgroup
n.tgroup
talign
talign
tvalign
tvalign
tstyle
tstyle
bgroup
bgroup
n.bgroup
n.bgroup
balign
balign
bvalign
bvalign
bstyle
bstyle
...
...
show.t2t.list
Description
show.t2t.list
Usage
show.t2t.list(
x,
caption = NULL,
caption.level = NULL,
list.type = "bullet",
...
)
Arguments
x
x
caption
caption
caption.level
caption.level
list.type
list.type
...
...
show.t2t.table
Description
show.t2t.table
Usage
show.t2t.table(
x,
include.rownames = FALSE,
include.colnames = FALSE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = FALSE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
...
)
Arguments
x
x
include.rownames
include.rownames
include.colnames
include.colnames
rownames
rownames
colnames
colnames
format
format
digits
digits
decimal.mark
decimal.mark
na.print
na.print
caption
caption
caption.level
width
width
frame
frame
grid
grid
valign
valign
header
header
footer
footer
align
align
col.width
col.width
style
style
lgroup
lgroup
n.lgroup
n.lgroup
lalign
lalign
lvalign
lvalign
lstyle
lstyle
rgroup
rgroup
n.rgroup
n.rgroup
ralign
ralign
rvalign
rvalign
rstyle
rstyle
tgroup
tgroup
n.tgroup
n.tgroup
talign
talign
tvalign
tvalign
tstyle
tstyle
bgroup
bgroup
n.bgroup
n.bgroup
balign
balign
bvalign
bvalign
bstyle
bstyle
...
...
show.textile.list
Description
show.textile.list
Usage
show.textile.list(
x,
caption = NULL,
caption.level = NULL,
list.type = "bullet",
...
)
Arguments
x
x
caption
caption
caption.level
caption.level
list.type
list.type
...
...
show.textile.table
Description
show.textile.table
Usage
show.textile.table(
x,
include.rownames = FALSE,
include.colnames = FALSE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = "",
caption = NULL,
caption.level = NULL,
width = 0,
frame = NULL,
grid = NULL,
valign = NULL,
header = FALSE,
footer = FALSE,
align = NULL,
col.width = 1,
style = NULL,
lgroup = NULL,
n.lgroup = NULL,
lalign = "c",
lvalign = "middle",
lstyle = "h",
rgroup = NULL,
n.rgroup = NULL,
ralign = "c",
rvalign = "middle",
rstyle = "h",
tgroup = NULL,
n.tgroup = NULL,
talign = "c",
tvalign = "middle",
tstyle = "h",
bgroup = NULL,
n.bgroup = NULL,
balign = "c",
bvalign = "middle",
bstyle = "h",
...
)
Arguments
x
x
include.rownames
include.rownames
include.colnames
include.colnames
rownames
rownames
colnames
colnames
format
format
digits
digits
decimal.mark
decimal.mark
na.print
na.print
caption
caption
caption.level
width
width
frame
frame
grid
grid
valign
valign
header
header
footer
footer
align
align
col.width
col.width
style
style
lgroup
lgroup
n.lgroup
n.lgroup
lalign
lalign
lvalign
lvalign
lstyle
lstyle
rgroup
rgroup
n.rgroup
n.rgroup
ralign
ralign
rvalign
rvalign
rstyle
rstyle
tgroup
tgroup
n.tgroup
n.tgroup
talign
talign
tvalign
tvalign
tstyle
tstyle
bgroup
bgroup
n.bgroup
n.bgroup
balign
balign
bvalign
bvalign
bstyle
bstyle
...
...
tocharac
Description
tocharac
Usage
tocharac(
x,
include.rownames = FALSE,
include.colnames = FALSE,
rownames = NULL,
colnames = NULL,
format = "f",
digits = 2,
decimal.mark = ".",
na.print = ""
)
Arguments
x
x
include.rownames
include.rownames
include.colnames
include.colnames
rownames
rownames
colnames
colnames
format
format
digits
digits
decimal.mark
decimal.mark
na.print
na.print
trim
Description
trim
Usage
trim(x)
Arguments
x
x
Create a verbatim paragraph
Description
verbatim can be used with export function to add a verbatim paragraph
Usage
verbatim(...)
Arguments
...
strings composing the paragraph (line by line)
Value
A verbatim object.
Author(s)
David Hajage
vsep.asciidoc
Description
vsep.asciidoc
Usage
vsep.asciidoc(align = NULL, valign = NULL, style = NULL)
Arguments
align
align
valign
valign
style
style
vsep.textile
Description
vsep.textile
Usage
vsep.textile(align = NULL, valign = NULL, style = NULL)
Arguments
align
align
valign
valign
style
style
weaverAsciiFinish
Description
weaverAsciiFinish
Usage
weaverAsciiFinish(object, error = FALSE)
Arguments
object
object
error
error