XLConnect v1.0.2


Monthly downloads



Excel Connector for R

Provides comprehensive functionality to read, write and format Excel data.


XLConnect: Excel Connector for R

CRAN\_Status\_Badge Rdoc Research software impact R codecov

XLConnect is a comprehensive and cross-platform R package for manipulating Microsoft Excel files from within R. XLConnect differs from other related R packages in that it is completely cross-platform and as such runs under Windows, Unix/Linux and Mac (32- and 64-bit). Moreover, it does not require any installation of Microsoft Excel or any other special drivers to be able to read & write Excel files. The only requirement is a recent version of a Java Runtime Environment (JRE).

The package can easily be installed from CRAN via install.packages("XLConnect"). In order to get started have a look at the XLConnect and XLConnect for the Impatient package vignettes, the numerous demos available via demo(package = "XLConnect") or browse through the comprehensive reference manual.

Alternatively, you may install XLConnect directly from our github repository using the excellent devtools package:


# Installs the master branch of XLConnect (= current development version)

# Installs XLConnect with the given version, e.g. 1.0.2
install_github("miraisolutions/xlconnect", ref = "<version>")

Please send any enhancement requests or bug reports with a simple and self-contained reproducible example to xlconnect@mirai-solutions.com or log a corresponding issue on our github repository. For other questions you may also use Stackoverflow.

Build for release on CRAN


Functions in XLConnect

Name Description
addImage-methods Adding images to a worksheet
createCellStyle-methods Creating custom named and anonymous cell styles
aref Constructing Excel area references
extractSheetName Extracting the sheet name from a formula
createFreezePane-methods Creating a freeze pane on a worksheet
appendWorksheet-methods Appending data to worksheets
extraction-methods Workbook data extraction & replacement operators
XLConnect-deprecated Deprecated functions in package XLConnect
clearNamedRegion-methods Clearing named regions in a workbook
idx2col Converting column indices to Excel column names
getActiveSheetIndex-methods Querying the active worksheet index
XLC XLConnect Constants
idx2cref Converting indices to Excel cell references
isSheetHidden-methods Checking if worksheets are hidden in a workbook
readWorksheetFromFile Reading data from worksheets in an Excel file (wrapper function)
isSheetVeryHidden-methods Checking if worksheets are very hidden in a workbook
removeName-methods Removing names from workbooks
getActiveSheetName-methods Querying the active worksheet name
getOrCreateCellStyle-methods Retrieving or creating named cell styles
setForceFormulaRecalculation-methods Forcing Excel to recalculate formula values when opening a workbook
clearRange-methods Clearing cell ranges in a workbook
clearRangeFromReference-methods Clearing cell ranges in a workbook
clearSheet-methods Clearing worksheets in a workbook
hideSheet-methods Hiding worksheets in a workbook
getReferenceCoordinates-methods Querying the coordinates of the range reference by an Excel name
getForceFormulaRecalculation-methods Querying the coordinates of the range reference by an Excel name
idx2aref Converting row and column based area references to Excel area references
existsName-methods Checking existence of names in a workbook
existsSheet-methods Checking for existence of worksheets in a workbook
getDefinedNames-methods Retrieving defined names in a workbook
loadWorkbook Loading Microsoft Excel workbooks
createSplitPane-methods Creating a split pane on a worksheet
cref2idx Converting Excel cell references to indices
mirai Mirai Solutions GmbH
getBoundingBox-methods Querying the coordinates of a worksheet bounding box
mergeCells-methods Merging cells
XLConnectSettings Performing general settings for XLConnect
normalizeDataframe Data frame Normalization for Unit Tests
getCellStyle-methods Retrieving named cell styles
XLConnect-package Excel Connector for R
col2idx Converting Excel column names to indices
cloneSheet-methods Cloning/copying worksheets
getCellFormula-methods Retrieving formula definitions from cells
getTables-methods Querying available Excel tables in a workbook
readWorksheet-methods Reading data from worksheets
getCellStyleForType-methods Querying the cell style per data type for the DATATYPE style action
getSheets-methods Querying available worksheets in a workbook
readTable Reading Excel tables from a workbook
setHyperlink-methods Setting hyperlinks
getReferenceCoordinatesForTable-methods Querying the coordinates of the range of an Excel table
getReferenceCoordinatesForName-methods Querying the coordinates of the range reference by an Excel name
readNamedRegionFromFile Reading named regions from an Excel file (wrapper function)
jTryCatch Standard Java exception handling for XLConnect
readNamedRegion Reading named regions from a workbook
isSheetVisible-methods Checking if worksheets are visible in a workbook
aref2idx Converting Excel cell references to row and column based cell references
createSheet-methods Creating worksheets in a workbook
renameSheet-methods Renaming worksheets from workbooks
$-methods Executing workbook methods in object$method(...) form
createName-methods Creating names in a workbook
cellstyle-class Class "cellstyle"
setColumnWidth-methods Setting the width of a column in a worksheet
existsCellStyle-methods Retrieving named cell styles
setBorder-methods Specifying borders for cell styles
getLastColumn-methods Querying the last (non-empty) column on a worksheet
setActiveSheet-methods Setting the active worksheet in a workbook
setCellFormula-methods Setting cell formulas
saveWorkbook-methods Saving Microsoft Excel workbooks
setDataFormat-methods Specifying custom data formats for cell styles
setStyleAction-methods Controlling application of cell styles when writing data to Excel
writeNamedRegionToFile Writing named regions to an Excel file (wrapper function)
getLastRow-methods Querying the last (non-empty) row on a worksheet
getReferenceFormula-methods Querying reference formulas of Excel names
show-methods Display a workbook object
setWrapText-methods Specifying text wrapping behaviour
getSheetPos-methods Querying worksheet position
setAutoFilter-methods Setting auto-filters on worksheets
setDataFormatForType-methods Setting the data format for the DATA_FORMAT_ONLY style action
onErrorCell-methods Behavior when error cells are detected
writeWorksheet-methods Writing data to worksheets
with.workbook Evaluate an R expression in a workbook environment
setStyleNamePrefix-methods Setting the style name prefix for the "name prefix" style action
setSheetPos-methods Setting worksheet position
setSheetColor-methods Setting colors on worksheet tabs
setFillBackgroundColor-methods Specifying the fill background color for cell styles
workbook-class Class "workbook"
unhideSheet-methods Unhiding worksheets in a workbook
print-methods Print a workbook's filename
setMissingValue-methods Setting missing value identifiers
xlcMemoryReport Reporting free Java Virtual Machine memory
xlcFreeMemory Freeing Java Virtual Machine memory
xlcDump Dumping data sets to Excel files
xlcEdit Editing data sets in an Excel file editor
unmergeCells-methods Unmerging cells
removePane-methods Removing panes from worksheet
setRowHeight-methods Setting the height of a row in a worksheet
setCellStyle-methods Setting cell styles
removeSheet-methods Removing worksheets from workbooks
setCellStyleForType-methods Setting the cell style per data type for the DATATYPE style action
setFillForegroundColor-methods Specifying the fill foreground color for cell styles
wrapList Wrapping of arguments in a list
setFillPattern-methods Specifying the fill pattern for cell styles
xlcCall Automatic argument vectorization, default Java exception and warnings handling for XLConnect
swissfranc Historical Exchange Rates: CHF vs EUR, USD and GBP
writeWorksheetToFile Writing data to worksheets in an Excel file (wrapper function)
summary-methods Summarizing workbook objects
xlcRestore Restoring objects from Excel files
writeNamedRegion-methods Writing named regions to a workbook
appendNamedRegion-methods Appending data to a named region
No Results!

Vignettes of XLConnect

No Results!

Last month downloads


Type Package
URL https://mirai-solutions.ch https://github.com/miraisolutions/xlconnect
BugReports https://github.com/miraisolutions/xlconnect/issues
SystemRequirements Java (>= 8, <= 15)
License GPL-3
Copyright See file COPYRIGHTS
LazyData yes
NeedsCompilation no
Packaged 2021-02-12 14:33:36 UTC; simon
Repository CRAN
Date/Publication 2021-02-15 06:10:07 UTC

Include our badge in your README