Learn R Programming

⚠️There's a newer version (1.2.0) of this package.Take me there.

XLConnect: Excel Connector for R

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:

require(devtools)

# Installs the master branch of XLConnect (= current development version)
install_github("miraisolutions/xlconnect")

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

Please log any enhancement requests or bug reports with a simple and self-contained reproducible example as an issue on our github repository. For other questions you may also use Stackoverflow.

Build for release on CRAN

devtools::build(args=c("--compact-vignettes=gs+qpdf"))

Copy Link

Version

Install

install.packages('XLConnect')

Monthly Downloads

6,760

Version

1.0.8

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Martin Studer

Last Published

January 30th, 2024

Functions in XLConnect (1.0.8)

createSheet-methods

Creating worksheets in a workbook
getActiveSheetIndex-methods

Querying the active worksheet index
existsCellStyle-methods

Retrieving named cell styles
extractSheetName

Extracting the sheet name from a formula
col2idx

Converting Excel column names to indices
$-methods

Executing workbook methods in object$method(...) form
extraction-methods

Workbook data extraction & replacement operators
cref2idx

Converting Excel cell references to indices
getLastRow-methods

Querying the last (non-empty) row on a worksheet
getDefinedNames-methods

Retrieving defined names in a workbook
createSplitPane-methods

Creating a split pane on a worksheet
createFreezePane-methods

Creating a freeze pane on a worksheet
getForceFormulaRecalculation-methods

Querying the coordinates of the range reference by an Excel name
getLastColumn-methods

Querying the last (non-empty) column on a worksheet
getActiveSheetName-methods

Querying the active worksheet name
existsSheet-methods

Checking for existence of worksheets in a workbook
existsName-methods

Checking existence of names in a workbook
getReferenceCoordinates-methods

Querying the coordinates of the range reference by an Excel name
getTables-methods

Querying available Excel tables in a workbook
getReferenceFormula-methods

Querying reference formulas of Excel names
getSheetPos-methods

Querying worksheet position
getSheets-methods

Querying available worksheets in a workbook
getOrCreateCellStyle-methods

Retrieving or creating named cell styles
getBoundingBox-methods

Querying the coordinates of a worksheet bounding box
mirai

Mirai Solutions GmbH
getCellStyle-methods

Retrieving named cell styles
idx2col

Converting column indices to Excel column names
idx2cref

Converting indices to Excel cell references
normalizeDataframe

Data frame Normalization for Unit Tests
getCellStyleForType-methods

Querying the cell style per data type for the DATATYPE style action
getCellFormula-methods

Retrieving formula definitions from cells
getReferenceCoordinatesForName-methods

Querying the coordinates of the range reference by an Excel name
jTryCatch

Standard Java exception handling for XLConnect
isSheetVisible-methods

Checking if worksheets are visible in a workbook
readWorksheetFromFile

Reading data from worksheets in an Excel file (wrapper function)
isSheetHidden-methods

Checking if worksheets are hidden in a workbook
setDataFormatForType-methods

Setting the data format for the DATA_FORMAT_ONLY style action
removePane-methods

Removing panes from worksheet
removeSheet-methods

Removing worksheets from workbooks
setFillBackgroundColor-methods

Specifying the fill background color for cell styles
hideSheet-methods

Hiding worksheets in a workbook
setColumnWidth-methods

Setting the width of a column in a worksheet
setSheetColor-methods

Setting colors on worksheet tabs
idx2aref

Converting row and column based area references to Excel area references
getReferenceCoordinatesForTable-methods

Querying the coordinates of the range of an Excel table
loadWorkbook

Loading Microsoft Excel workbooks
onErrorCell-methods

Behavior when error cells are detected
print-methods

Print a workbook's filename
mergeCells-methods

Merging cells
removeName-methods

Removing names from workbooks
setDataFormat-methods

Specifying custom data formats for cell styles
isSheetVeryHidden-methods

Checking if worksheets are very hidden in a workbook
setSheetPos-methods

Setting worksheet position
xlcDump

Dumping data sets to Excel files
xlcEdit

Editing data sets in an Excel file editor
setCellStyle-methods

Setting cell styles
setFillForegroundColor-methods

Specifying the fill foreground color for cell styles
readTable

Reading Excel tables from a workbook
setCellStyleForType-methods

Setting the cell style per data type for the DATATYPE style action
renameSheet-methods

Renaming worksheets from workbooks
saveWorkbook-methods

Saving Microsoft Excel workbooks
setMissingValue-methods

Setting missing value identifiers
readWorksheet-methods

Reading data from worksheets
readNamedRegion

Reading named regions from a workbook
setStyleAction-methods

Controlling application of cell styles when writing data to Excel
setRowHeight-methods

Setting the height of a row in a worksheet
summary-methods

Summarizing workbook objects
setStyleNamePrefix-methods

Setting the style name prefix for the "name prefix" style action
swissfranc

Historical Exchange Rates: CHF vs EUR, USD and GBP
wrapList

Wrapping of arguments in a list
setActiveSheet-methods

Setting the active worksheet in a workbook
readNamedRegionFromFile

Reading named regions from an Excel file (wrapper function)
setFillPattern-methods

Specifying the fill pattern for cell styles
writeNamedRegion-methods

Writing named regions to a workbook
setAutoFilter-methods

Setting auto-filters on worksheets
setForceFormulaRecalculation-methods

Forcing Excel to recalculate formula values when opening a workbook
setHyperlink-methods

Setting hyperlinks
writeWorksheetToFile

Writing data to worksheets in an Excel file (wrapper function)
setBorder-methods

Specifying borders for cell styles
with.workbook

Evaluate an R expression in a workbook environment
unhideSheet-methods

Unhiding worksheets in a workbook
xlcCall

Automatic argument vectorization, default Java exception and warnings handling for XLConnect
workbook-class

Class "workbook"
setCellFormula-methods

Setting cell formulas
setWrapText-methods

Specifying text wrapping behaviour
xlcRestore

Restoring objects from Excel files
unmergeCells-methods

Unmerging cells
show-methods

Display a workbook object
writeNamedRegionToFile

Writing named regions to an Excel file (wrapper function)
xlcFreeMemory

Freeing Java Virtual Machine memory
xlcMemoryReport

Reporting free Java Virtual Machine memory
writeWorksheet-methods

Writing data to worksheets
cellstyle-class

Class "cellstyle"
XLConnect-deprecated

Deprecated functions in package XLConnect
XLConnect-package

Excel Connector for R
clearNamedRegion-methods

Clearing named regions in a workbook
cloneSheet-methods

Cloning/copying worksheets
createName-methods

Creating names in a workbook
createCellStyle-methods

Creating custom named and anonymous cell styles
clearRangeFromReference-methods

Clearing cell ranges in a workbook
XLC

XLConnect Constants
appendNamedRegion-methods

Appending data to a named region
aref2idx

Converting Excel cell references to row and column based cell references
aref

Constructing Excel area references
XLConnectSettings

Performing general settings for XLConnect
clearRange-methods

Clearing cell ranges in a workbook
appendWorksheet-methods

Appending data to worksheets
addImage-methods

Adding images to a worksheet
clearSheet-methods

Clearing worksheets in a workbook