write.xlsx: write data to an xlsx file
In awalker89/openxlsx: Read, Write and Edit XLSX Files

Description Usage Arguments Details Value Author(s) See Also Examples

write a data.frame or list of data.frames to an xlsx file

1	write.xlsx(x, file, asTable = FALSE, ...)

`x`	object or a list of objects that can be handled by `writeData` to write to file
`file`	xlsx file name
`asTable`	write using writeDataTable as opposed to writeData
`...`	optional parameters to pass to functions: createWorkbook addWorksheet writeData freezePane saveWorkbook see details.

Optional parameters are:

createWorkbook Parameters

creator A string specifying the workbook author

addWorksheet Parameters

sheetName Name of the worksheet
gridLines A logical. If FALSE, the worksheet grid lines will be hidden.
tabColour Colour of the worksheet tab. A valid colour (belonging to colours()) or a valid hex colour beginning with "#".
zoom A numeric between 10 and 400. Worksheet zoom level as a percentage.

writeData/writeDataTable Parameters

startCol A vector specifying the starting column(s) to write df
startRow A vector specifying the starting row(s) to write df
xy An alternative to specifying startCol and startRow individually. A vector of the form c(startCol, startRow)
colNames or col.names If TRUE, column names of x are written.
rowNames or row.names If TRUE, row names of x are written.
headerStyle Custom style to apply to column names.
borders Either "surrounding", "columns" or "rows" or NULL. If "surrounding", a border is drawn around the data. If "rows", a surrounding border is drawn a border around each row. If "columns", a surrounding border is drawn with a border between each column. If "all" all cell borders are drawn.
borderColour Colour of cell border
borderStyle Border line style.
keepNA If TRUE, NA values are converted to #N/A in Excel else NA cells will be empty. Defaults to FALSE.

freezePane Parameters

firstActiveRow Top row of active region to freeze pane.
firstActiveCol Furthest left column of active region to freeze pane.
firstRow If TRUE, freezes the first row (equivalent to firstActiveRow = 2)
firstCol If TRUE, freezes the first column (equivalent to firstActiveCol = 2)

colWidths Parameters

colWidths Must be value "auto". Sets all columns containing data to auto width.

saveWorkbook Parameters

overwrite Overwrite existing file (Defaults to TRUE as with write.table)

columns of x with class Date or POSIXt are automatically styled as dates and datetimes respectively.

A workbook object

Alexander Walker

addWorksheet

writeData

createStyle for style parameters

## write to working directory
options("openxlsx.borderColour" = "#4F80BD") ## set default border colour
write.xlsx(iris, file = "writeXLSX1.xlsx", colNames = TRUE, borders = "columns")
write.xlsx(iris, file = "writeXLSX2.xlsx", colNames = TRUE, borders = "surrounding")


hs <- createStyle(textDecoration = "BOLD", fontColour = "#FFFFFF", fontSize=12,
                  fontName="Arial Narrow", fgFill = "#4F80BD")

write.xlsx(iris, file = "writeXLSX3.xlsx", colNames = TRUE, borders = "rows", headerStyle = hs)

## Lists elements are written to individual worksheets, using list names as sheet names if available
l <- list("IRIS" = iris, "MTCATS" = mtcars, matrix(runif(1000), ncol = 5))
write.xlsx(l, "writeList1.xlsx", colWidths = c(NA, "auto", "auto"))

## different sheets can be given different parameters
write.xlsx(l, "writeList2.xlsx", startCol = c(1,2,3), startRow = 2,
           asTable = c(TRUE, TRUE, FALSE), withFilter = c(TRUE, FALSE, FALSE))