Read, Write and Edit xlsx Files

---

Documentation for package ‘openxlsx’ version 4.2.5.2

• DESCRIPTION file.
• User guides, package vignettes and other documentation.

Help Pages

%||%	If NULL then ...
activeSheet	Get/set active sheet of the workbook
activeSheet<-	Get/set active sheet of the workbook
addCreator	Add another author to the meta data of the file.
addFilter	Add column filters
addStyle	Add a style to a set of cells
addWorksheet	Add a worksheet to a workbook
all.equal	Check equality of workbooks
all.equal.Workbook	Check equality of workbooks
buildWorkbook	Build Workbook
cloneWorksheet	Clone a worksheet to a workbook
col2int	Convert Excel column to integer
conditionalFormat	Add conditional formatting to cells
conditionalFormatting	Add conditional formatting to cells
convertFromExcelRef	Convert excel column name to integer index
convertToDate	Convert from excel date number to R Date type
convertToDateTime	Convert from excel time number to R POSIXct type.
copyWorkbook	Copy a Workbook object.
createComment	create a Comment object
createNamedRegion	Create / delete a named region.
createStyle	Create a cell style
createWorkbook	Create a new Workbook object
databar	Add conditional formatting to cells
dataValidation	Add data validation to cells
deleteData	Delete cell data
deleteNamedRegion	Create / delete a named region.
freezePane	Freeze a worksheet pane
getBaseFont	Return the workbook default font
getCellRefs	Return excel cell coordinates from (x,y) coordinates
getCreators	Add another author to the meta data of the file.
getDateOrigin	Get the date origin an xlsx file is using
getNamedRegions	Get named regions
getSheetNames	Get names of worksheets
getStyles	Returns a list of all styles in the workbook
getTables	List Excel tables in a workbook
groupColumns	Group columns
groupRows	Group Rows
if_null_then	If NULL then ...
insertImage	Insert an image into a worksheet
insertPlot	Insert the current plot into a worksheet
int2col	Convert integer to Excel column
loadWorkbook	Load an existing .xlsx file
makeHyperlinkString	create Excel hyperlink string
mergeCells	Merge cells within a worksheet
modifyBaseFont	Modify the default font
names	get or set worksheet names
names.Workbook	get or set worksheet names
names<-.Workbook	get or set worksheet names
op.openxlsx	openxlsx Options
openXL	Open a Microsoft Excel file (xls/xlsx) or an openxlsx Workbook
openxlsx	xlsx reading, writing and editing.
openxlsxFontSizeLookupTable	Font Size Lookup tables
openxlsxFontSizeLookupTableBold	Font Size Lookup tables
openxlsx_getOp	openxlsx Options
openxlsx_options	openxlsx Options
openxlsx_setOp	openxlsx Options
pageBreak	add a page break to a worksheet
pageSetup	Set page margins, orientation and print scaling
protectWorkbook	Protect a workbook from modifications
protectWorksheet	Protect a worksheet from modifications
read.xlsx	Read from an Excel file or Workbook object
readWorkbook	Read from an Excel file or Workbook object
removeCellMerge	Create a new Workbook object
removeColWidths	Remove column widths from a worksheet
removeComment	Remove a comment from a cell
removeFilter	Remove a worksheet filter
removeRowHeights	Remove custom row heights from a worksheet
removeTable	Remove an Excel table in a workbook
removeWorksheet	Remove a worksheet from a workbook
renameWorksheet	Rename a worksheet
replaceStyle	Replace an existing cell style
saveWorkbook	save Workbook to file
setColWidths	Set worksheet column widths
setFooter	Set footer for all worksheets
setHeader	Set header for all worksheets
setHeaderFooter	Set document headers and footers
setLastModifiedBy	Add another author to the meta data of the file.
setRowHeights	Set worksheet row heights
sheets	Returns names of worksheets.
sheetVisibility	Get/set worksheet visible state
sheetVisibility<-	Get/set worksheet visible state
sheetVisible	Get worksheet visible state.
sheetVisible<-	Get worksheet visible state.
showGridLines	Set worksheet gridlines to show or hide.
temp_xlsx	helper function to create tempory directory for testing purpose
ungroupColumns	Ungroup Columns
ungroupRows	Ungroup Rows
worksheetOrder	Order of worksheets in xlsx file
worksheetOrder<-	Order of worksheets in xlsx file
write.xlsx	write data to an xlsx file
writeComment	write a cell comment
writeData	Write an object to a worksheet
writeDataTable	Write to a worksheet as an Excel table
writeFormula	Write a character vector as an Excel Formula