Header labels

Specify column labels to display with argument header.labels

The following code:

require( R2DOCX )

# Create a new object
doc = new("Docx", title = "My example" )

desc( iris )
#'data.frame':   150 obs. of  5 variables:
# $ Sepal.Length: num  5.1 4.9 4.7 4.6 5 5.4 4.6 5 4.4 4.9 ...
# $ Sepal.Width : num  3.5 3 3.2 3.1 3.6 3.9 3.4 3.4 2.9 3.1 ...
# $ Petal.Length: num  1.4 1.4 1.3 1.5 1.4 1.7 1.4 1.5 1.4 1.5 ...
# $ Petal.Width : num  0.2 0.2 0.2 0.2 0.2 0.4 0.3 0.2 0.2 0.1 ...
# $ Species
doc = addTable( doc , iris[1:5, ]
        , header.labels = list(
        "Sepal.Length" = " Sepal Length", "Sepal.Width" = " Sepal Width"
        , "Petal.Length" = " Petal Length", "Petal.Width" = " Petal Width"
        , "Species" = "Species"
        )
)

# write Word document
writeDoc( doc, "document.docx" )

should produce that table:

Grouped header labels

The following code:

require( R2DOCX )

# Create a new object
doc = new("Docx", title = "My example" )

doc = addTable( doc
, iris[1:5,]
, grouped.cols=list( "Sepal" = c( "Sepal.Length", "Sepal.Width" )
        , "Petal" = c("Petal.Length", "Petal.Width")
        , "Species" = c("Species")
)
)

# write Word document
writeDoc( doc, "document.docx" )

should produce that table

Argument grouped.colsis a named list:

• Names are labels to display, list elements are character vector containing data column names to gather under one label.
• All columns names must be in exactly one element.
• Order of appearance in elements must be the order of columns names in the dataset.
• E.g. if columns are 'col1', 'col2', 'col3', argument cannot be:

  list ('colgroup1'='col2', 'colgroup2'=c('col1', 'col3'))

• To leave blank headers labels, name the element the same that the column name:

  doc = addTable( doc, iris, grouped.cols=list( ..., "Species" = "Species" ) )

Merging data cell

If argument span.columns is used, identical successive cells inside columns will be merged.

doc = addTable( doc
        , iris[46:55, c(5,1:4) ]
        , span.columns = "Species"
)

Coloring data cell or font

For coloring fonts of columns use argument col.fontcolors

For coloring cell backgrounds of columns use argument col.colors

The following code:

doc = addTable( doc
        , iris[ 1:5, ]
        , col.fontcolors = list( Species = c("red", "blue"
                , "red", "blue", "red" ) )
        , col.colors = list( Sepal.Length = c("red", "blue"
                , "red", "blue", "red" ) )
)

should produce that table

Formating tables

details

Complete example

doc = addTable( doc
        , data = weights.summary
        , header.labels = list("id" = "Subject Identifier", "avg.weight" = "Average Weight"
                , "regularity" = "Regularity", "visit.n" = "Number of visits", "last.day" = "Last visit"
        ) # columns labels to display
        , grouped.cols=list( "id" = "id"
                , "Summary" = c( "avg.weight",  "regularity", "visit.n", "last.day" )
        ) # grouped headers line to add before headers line
        , col.types = list( "id" = "character", "avg.weight" = "double"
                , "regularity" = "percent", "visit.n" = "integer"
                , "last.day" = "date" ) # reporting types of each columns 
        , col.fontcolors = list( "regularity" = ifelse( weights.summary$regularity < 0.5 , "gray", "blue") ) # customized font colors for column "regularity"
)