You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

37 lines
1.8KB

  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/output.R
  3. \name{pander.desctable}
  4. \alias{pander.desctable}
  5. \title{Pander method for desctable}
  6. \usage{
  7. pander.desctable(x = NULL, digits = 2, justify = "left",
  8. missing = "", keep.line.breaks = T, split.tables = Inf,
  9. emphasize.rownames = F, ...)
  10. }
  11. \arguments{
  12. \item{x}{A desctable}
  13. \item{digits}{passed to \code{format}. Can be a vector specifying values for each column (has to be the same length as number of columns).}
  14. \item{justify}{defines alignment in cells passed to \code{format}. Can be \code{left}, \code{right} or \code{centre}, which latter can be also spelled as \code{center}. Defaults to \code{centre}. Can be abbreviated to a string consisting of the letters \code{l}, \code{c} and \code{r} (e.g. 'lcr' instead of c('left', 'centre', 'right').}
  15. \item{missing}{string to replace missing values}
  16. \item{keep.line.breaks}{(default: \code{FALSE}) if to keep or remove line breaks from cells in a table}
  17. \item{split.tables}{where to split wide tables to separate tables. The default value (\code{80}) suggests the conventional number of characters used in a line, feel free to change (e.g. to \code{Inf} to disable this feature) if you are not using a VT100 terminal any more :)}
  18. \item{emphasize.rownames}{boolean (default: \code{TRUE}) if row names should be highlighted}
  19. \item{...}{unsupported extra arguments directly placed into \code{/dev/null}}
  20. }
  21. \description{
  22. Pander method to output a desctable
  23. }
  24. \details{
  25. Uses \code{pandoc.table}, with some default parameters (\code{digits = 2}, \code{justify = "left"}, \code{missing = ""}, \code{keep.line.breaks = T}, \code{split.tables = Inf}, and \code{emphasize.rownames = F}), that you can override if needed.
  26. }
  27. \seealso{
  28. \code{\link{pandoc.table}}
  29. }