Description Usage Arguments Details Value Author(s) Examples
Convert an R object to an ascii
object, which can then be
printed with asciidoc, txt2tags, reStructuredText, org, textile or
pandoc syntax.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | ## 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 '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 'sessionInfo'
ascii(x, locale = TRUE, ...)
## 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, ...)
ascii(x, ...)
|
x |
An R object of class found among
|
include.rownames |
logical. If |
include.colnames |
logical. If |
rownames |
Character vector (replicated or truncated
as necessary) indicating rownames of the corresponding
rows. If |
colnames |
Character vector (replicated or truncated
as necessary) indicating colnames of the corresponding
columns. If |
format |
Character vector or matrix indicating the
format for the corresponding columns. These values are
passed to the |
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 |
decimal.mark |
The character to be used to indicate
the numeric decimal point. Default is |
na.print |
The character string specifying how
|
caption |
Character vector of length 1 containing
the table's caption or title. Set to |
caption.level |
Character or numeric vector of
length 1 containing the caption's level. Can take the
following values: |
width |
Numeric vector of length one containing the
table width relative to the available width (expressed as
a percentage value, |
frame |
Character vector of length one. Defines the
table border, and can take the following values:
|
grid |
Character vector of length one. Defines which
ruler lines are drawn between table rows and columns, and
can take the following values: |
valign |
Vector or matrix indicating vertical
alignment of all cells in table. Can take the following
values: |
header |
logical or numeric. If |
footer |
logical or numeric. If |
align |
Vector or matrix indicating the alignment of
the corresponding columns. Can be composed with
|
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 |
style |
Character vector or matrix indicating the
style of the corresponding columns. Can be composed with
|
tgroup |
Character vector or a list of character
vectors defining major top column headings. The default
is to have none ( |
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
|
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 ( |
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 ( |
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
|
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 ( |
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
|
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 |
list.type |
Character vector of length one
indicating the list type ( |
... |
Additional arguments. (Currently ignored.) |
condense |
default is TRUE to condense the output
with regard to the 5 lowest and highest values and the
frequency table ( |
vnames |
By default, tables and plots are usually
labeled with variable labels (see |
prUnits |
set to |
prn |
set to |
pctdig |
number of digits to the right of the
decimal place for printing percentages (see
|
npct |
specifies which counts are to be printed to
the right of percentages (see |
exclude1 |
by default, |
sep |
character to use to separate quantiles when
printing |
formatArgs |
a list containing other arguments to
pass to |
round |
Specify |
prtest |
a vector of test statistic components to
print if |
prmsd |
set to |
pdig |
number of digits to the right of the decimal
place for printing P-values. (see |
eps |
P-values less than |
twoway |
controls whether the resulting table will
be printed in enumeration format or as a two-way table
(the default) (see |
prnmiss |
set to |
locale |
show locale information? |
scale |
A numeric value to rescale the survival
time, e.g., if the input data to survfit were in days,
|
print.rmean |
Option for computation and display of
the restricted mean (see |
rmean |
Option for computation and display of the
restricted mean (see |
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"
.
This function returns an object of class
"asciiTable"
, "asciiList"
or "asciiMixed"
.
David Hajage dhajage@gmail.com
1 2 3 4 5 6 7 8 |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.