ascii.default

0th

Percentile

Export R objects to several markup languages

Convert an R object to an ascii object, which can then be printed with asciidoc, txt2tags, reStructuredText, org, textile or pandoc syntax.

Keywords
print
Usage
"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", ...)
"ascii"(x, condense = TRUE, ...)
"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, ...)
"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", ...)
"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)), ...)
"ascii"(x, locale = TRUE, ...)
"ascii"(x, scale = 1, print.rmean = getOption("survfit.print.rmean"), rmean = getOption("survfit.rmean"), include.rownames = TRUE, include.colnames = TRUE, header = 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
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".
...
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 (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".

Aliases
  • ascii
  • ascii.anova
  • ascii.aov
  • ascii.aovlist
  • ascii.cast_df
  • ascii.character
  • ascii.coxph
  • ascii.CrossTable
  • ascii.data.frame
  • ascii.default
  • ascii.density
  • ascii.describe
  • ascii.describe.single
  • ascii.factor
  • ascii.freqtable
  • ascii.ftable
  • ascii.glm
  • ascii.htest
  • ascii.integer
  • ascii.list
  • ascii.lm
  • ascii.matrix
  • ascii.meanscomp
  • ascii.mtable
  • ascii.numeric
  • ascii.packageDescription
  • ascii.prcomp
  • ascii.sessionInfo
  • ascii.simple.list
  • ascii.smooth.spline
  • ascii.stat.table
  • ascii.summary.aov
  • ascii.summary.aovlist
  • ascii.summary.formula.cross
  • ascii.summary.formula.response
  • ascii.summary.formula.reverse
  • ascii.summary.glm
  • ascii.summary.lm
  • ascii.summary.prcomp
  • ascii.summary.survfit
  • ascii.summary.table
  • ascii.survdiff
  • ascii.survfit
  • ascii.table
  • ascii.ts
  • ascii.zoo
  • "package-ascii"
Examples
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))
Documentation reproduced from package ascii, version 2.2, License: GPL (>= 2)

Community examples

Looks like there are no examples yet.