XLConnect v0.2-15


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 Build Status 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)
install_github("xlconnect", username = "miraisolutions", ref = "master")

# Installs XLConnect 0.2-14
install_github("xlconnect", username = "miraisolutions", ref = "0.2-14")

For more examples see also our wordpress site.

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.

Functions in XLConnect

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

Vignettes of XLConnect

No Results!

Last month downloads


Type Package
Date 2018-04-05
URL http://www.mirai-solutions.com https://github.com/miraisolutions/xlconnect
BugReports https://github.com/miraisolutions/xlconnect/issues
SystemRequirements Java (>= 6)
License GPL-3
Copyright See file COPYRIGHTS
LazyData yes
NeedsCompilation no
Packaged 2018-04-05 16:00:57 UTC; mstuder
Repository CRAN
Date/Publication 2018-04-05 17:20:46 UTC

Include our badge in your README