FlexTable
FlexTable creation
Create an object of class FlexTable.
FlexTable can be manipulated so that almost any formatting
can be specified. It allows to insert headers and footers
rows with eventually merged cells (see
addHeaderRow and addFooterRow).
Formating can be done on cells, paragraphs and texts
(borders, colors, fonts, etc.) , see
alterFlexTable.
Usage
FlexTable(data, numrow, numcol, header.columns = TRUE, add.rownames = FALSE,
body.cell.props = cellProperties(), body.par.props = parProperties(),
body.text.props = textProperties(), header.cell.props = cellProperties(),
header.par.props = parProperties(),
header.text.props = textProperties(font.weight = "bold"))Arguments
- data
(a
data.frameormatrixobject) to add- numrow
number of row in the table body. Mandatory if data is missing.
- numcol
number of col in the table body. Mandatory if data is missing.
- header.columns
logical value - should the colnames be included in the table as table headers. If FALSE, no headers will be printed unless you use
addHeaderRow.- add.rownames
logical value - should the row.names be included in the table.
- body.cell.props
default cells formatting properties for table body
- body.par.props
default paragraphs formatting properties for table body
- body.text.props
default texts formatting properties for table body
- header.cell.props
default cells formatting properties for table headers
- header.par.props
default paragraphs formatting properties for table headers
- header.text.props
default texts formatting properties for table headers
Note
The classical workflow would be to create a FlexTable, to
add headers rows (see addHeaderRow) and
eventually footers rows (see addFooterRow).
Additionnal texts can be added with subscript syntax (see
alterFlexTable).
Texts, paragraphs and cells properties can be modified with
subscript syntax (see alterFlexTable).
Cells background colors can also be modified with functions
setRowsColors ,
setColumnsColors and
setZebraStyle.
Merging cells can be done with functions
spanFlexTableRows and
spanFlexTableColumns.
See Also
addHeaderRow, addFooterRow,
setFlexTableWidths ,
alterFlexTable,
setFlexTableBorders ,
spanFlexTableRows,
spanFlexTableColumns ,
setRowsColors,
setColumnsColors, setZebraStyle
, addFlexTable,
addFlexTable.docx ,
addFlexTable.pptx,
addFlexTable.html
Examples
# NOT RUN {
#START_TAG_TEST
#####################################################################
# set default font size to 10
options( "ReporteRs-fontsize" = 10 )
# Create a FlexTable with data.frame mtcars, display rownames
# use different formatting properties for header and body cells
MyFTable = FlexTable( data = mtcars, add.rownames = TRUE
, body.cell.props = cellProperties( border.color = "#EDBD3E")
, header.cell.props = cellProperties( background.color = "#5B7778" )
)
# zebra stripes - alternate colored backgrounds on table rows
MyFTable = setZebraStyle( MyFTable, odd = "#D1E6E7", even = "#93A8A9" )
# applies a border grid on table
MyFTable = setFlexTableBorders(MyFTable
, inner.vertical = borderProperties( color="#EDBD3E", style="dotted" )
, inner.horizontal = borderProperties( color = "#EDBD3E", style = "none" )
, outer.vertical = borderProperties( color = "#EDBD3E", style = "solid" )
, outer.horizontal = borderProperties( color = "#EDBD3E", style = "solid" )
)
#####################################################################
# set default font size to 10
options( "ReporteRs-fontsize" = 10 )
# a summary of mtcars
dataset = aggregate( mtcars[, c("disp", "mpg", "wt")]
, by = mtcars[, c("cyl", "gear", "carb")]
, FUN = mean )
dataset = dataset[ order(dataset$cyl, dataset$gear, dataset$carb), ]
# set cell padding defaut to 2
baseCellProp = cellProperties( padding = 2 )
# Create a FlexTable with data.frame dataset
MyFTable = FlexTable( data = dataset
, body.cell.props = baseCellProp
, header.cell.props = baseCellProp
, header.par.props = parProperties(text.align = "right" )
)
# set columns widths (in inches)
MyFTable = setFlexTableWidths( MyFTable, widths = c(0.5, 0.5, 0.5, 0.7, 0.7, 0.7) )
# span successive identical cells within column 1, 2 and 3
MyFTable = spanFlexTableRows( MyFTable, j = 1, runs = as.character( dataset$cyl ) )
MyFTable = spanFlexTableRows( MyFTable, j = 2, runs = as.character( dataset$gear ) )
MyFTable = spanFlexTableRows( MyFTable, j = 3, runs = as.character( dataset$carb ) )
# overwrites some text formatting properties
MyFTable[dataset$wt < 3, 6] = textProperties( color="#003366")
MyFTable[dataset$mpg < 20, 5] = textProperties( color="#993300")
# overwrites some paragraph formatting properties
MyFTable[, 1:3] = parProperties(text.align = "center")
MyFTable[, 4:6] = parProperties(text.align = "right")
# applies a border grid on table
MyFTable = setFlexTableBorders( MyFTable, footer=TRUE
, inner.vertical = borderProperties( color = "#666666" )
, inner.horizontal = borderProperties( color = "#666666" )
, outer.vertical = borderProperties( width = 2, color = "#666666" )
, outer.horizontal = borderProperties( width = 2, color = "#666666" )
)
#####################################################################
# set default font size to 10
options( "ReporteRs-fontsize" = 10 )
# a summary of mtcars
dataset = aggregate( mtcars[, c("disp", "mpg", "wt")]
, by = mtcars[, c("cyl", "gear", "carb")]
, FUN = mean )
dataset = dataset[ order(dataset$cyl, dataset$gear, dataset$carb), ]
# set cell padding defaut to 2
baseCellProp = cellProperties( padding = 2 )
# Create a FlexTable with data.frame dataset
MyFTable = FlexTable( data = dataset
, body.cell.props = baseCellProp
, header.cell.props = baseCellProp
, header.par.props = parProperties(text.align = "right" )
)
# set columns widths (in inches)
MyFTable = setFlexTableWidths( MyFTable, widths = c(0.5, 0.5, 0.5, 0.7, 0.7, 0.7) )
# span successive identical cells within column 1, 2 and 3
MyFTable = spanFlexTableRows( MyFTable, j = 1, runs = as.character( dataset$cyl ) )
MyFTable = spanFlexTableRows( MyFTable, j = 2, runs = as.character( dataset$gear ) )
MyFTable = spanFlexTableRows( MyFTable, j = 3, runs = as.character( dataset$carb ) )
# overwrites some text formatting properties
MyFTable[dataset$wt < 3, 6] = textProperties( color="#003366")
MyFTable[dataset$mpg < 20, 5] = textProperties( color="#993300")
# overwrites some paragraph formatting properties
MyFTable[, 1:3] = parProperties(text.align = "center")
MyFTable[, 4:6] = parProperties(text.align = "right")
# applies a border grid on table
MyFTable = setFlexTableBorders( MyFTable, footer=TRUE
, inner.vertical = borderProperties( color = "#666666" )
, inner.horizontal = borderProperties( color = "#666666" )
, outer.vertical = borderProperties( width = 2, color = "#666666" )
, outer.horizontal = borderProperties( width = 2, color = "#666666" )
)
data( iris )
iris = head( iris[, c(5, 1:4)] )
default_text = textProperties( font.size = 11 )
note_text = chprop(default_text, vertical.align = "superscript", color = "blue")
iris_ft = FlexTable( data = iris, header.columns = FALSE )
iris_ft = addHeaderRow( iris_ft, value = c("", "Measures" ), colspan = c( 4, 1 ) )
iris_ft = addHeaderRow( iris_ft, value = gsub( "\\.", " ", names( iris ) ) )
iris_ft[2, 2, newpar = TRUE ] = "Hi there"
iris_ft[2, 1, to="header"] = pot("* this is a note", note_text )
iris_ft = spanFlexTableRows( iris_ft, j = "Species", runs = as.character( iris$Species ) )
iris_ft = setFlexTableBorders( iris_ft,
inner.vertical = borderProperties( style = "none" ),
inner.horizontal = borderProperties( width = 1 ),
outer.vertical = borderProperties( width = 0 ),
outer.horizontal = borderProperties( width = 2 ),
footer = TRUE
)
#STOP_TAG_TEST
# }