odfTable {odfWeave}R Documentation

Create an Open Document Format table

Description

Create an Open Document Format table from a data frame, matrix or vector

Usage

odfTable(x, ...)

## S3 method for class 'numeric':
odfTable(x, horizontal = length(x) < 5, colnames = names(x), 
   digits = max(3, getOption("digits") - 3), 
   name = paste("Table", floor(runif(1) * 1000), sep = ""), 
   styles = NULL, ...)
  
## S3 method for class 'character':
odfTable(x, horizontal = length(x) < 5, colnames = names(x), 
   name = paste("Table", floor(runif(1) * 1000), sep = ""), 
   styles = NULL, ...)
   
  
## S3 method for class 'data.frame':
odfTable(x, colnames = NULL, useRowNames = TRUE, 
   digits = max(3, getOption("digits") - 3), 
   name = paste("Table", floor(runif(1) * 1000), sep = ""), 
   styles = NULL, ...)
   
## S3 method for class 'matrix':
odfTable(x, colnames = NULL, useRowNames = TRUE, 
   digits = max(3, getOption("digits") - 3),
    name = paste("Table", floor(runif(1) * 1000), sep = ""), 
    styles = NULL, ...)

Arguments

x a vector, matrix or data frame
horizontal a logical: should the vector be shown as a 1xn table or nx1? This is ignored for other data structures.
colnames a vector of column names that can be used. Note that if the row names are used in the table, this should contain an extra element for that column.
useRowNames a logical: should the row names be printed in the final table
digits number of significant digits passed to format
name A name for the table. ODF requires a name for each object, so a random name will be used if unspecified.
styles An optional list of style names for each table element (cells, headers etc). See tableStyles
... optional arguments that can be passed to format

Details

The data structures are converted to character matrices using format. The justify and trim arguments to format are usually overridden by the table style options, so those arguments are automatically set to justify = "none" and trim = TRUE. However, if values of these arguments are passed using the three dots, format will use them (but they probably won't do anything).

When using odfTable in a code chunk, the chunk's results argument should be set to xml.

The document formatting.odt in the package's examples directory illustrates the process of changing the appearance of the table.

Value

a list of character string that contain XML markup

Author(s)

Max Kuhn

See Also

tableStyles

Examples

odfTable(iris[1:5,])

[Package odfWeave version 0.7.9 Index]