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.6

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Martin Studer

Last Published

October 21st, 2022

Functions in XLConnect (1.0.6)

XLC

XLConnect Constants
addImage-methods

Adding images to a worksheet
XLConnect-deprecated

Deprecated functions in package XLConnect
appendNamedRegion-methods

Appending data to a named region
createCellStyle-methods

Creating custom named and anonymous cell styles
createFreezePane-methods

Creating a freeze pane on a worksheet
appendWorksheet-methods

Appending data to worksheets
createName-methods

Creating names in a workbook
aref2idx

Converting Excel cell references to row and column based cell references
cellstyle-class

Class "cellstyle"
createSheet-methods

Creating worksheets in a workbook
aref

Constructing Excel area references
clearRangeFromReference-methods

Clearing cell ranges in a workbook
XLConnect-package

Excel Connector for R
XLConnectSettings

Performing general settings for XLConnect
clearSheet-methods

Clearing worksheets in a workbook
createSplitPane-methods

Creating a split pane on a worksheet
clearNamedRegion-methods

Clearing named regions in a workbook
clearRange-methods

Clearing cell ranges in a workbook
existsName-methods

Checking existence of names in a workbook
extractSheetName

Extracting the sheet name from a formula
existsSheet-methods

Checking for existence of worksheets in a workbook
extraction-methods

Workbook data extraction & replacement operators
cref2idx

Converting Excel cell references to indices
getActiveSheetIndex-methods

Querying the active worksheet index
cloneSheet-methods

Cloning/copying worksheets
getActiveSheetName-methods

Querying the active worksheet name
getCellStyle-methods

Retrieving named cell styles
getBoundingBox-methods

Querying the coordinates of a worksheet bounding box
col2idx

Converting Excel column names to indices
getCellStyleForType-methods

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

Retrieving or creating named cell styles
getReferenceFormula-methods

Querying reference formulas of Excel names
getSheetPos-methods

Querying worksheet position
getReferenceCoordinates-methods

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

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

Retrieving formula definitions from cells
getSheets-methods

Querying available worksheets in a workbook
getDefinedNames-methods

Retrieving defined names in a workbook
loadWorkbook

Loading Microsoft Excel workbooks
hideSheet-methods

Hiding worksheets in a workbook
idx2aref

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

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

Retrieving named cell styles
mergeCells-methods

Merging cells
mirai

Mirai Solutions GmbH
getTables-methods

Querying available Excel tables in a workbook
getLastColumn-methods

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

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

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

Querying the coordinates of the range of an Excel table
removePane-methods

Removing panes from worksheet
onErrorCell-methods

Behavior when error cells are detected
removeSheet-methods

Removing worksheets from workbooks
isSheetHidden-methods

Checking if worksheets are hidden in a workbook
setBorder-methods

Specifying borders for cell styles
isSheetVeryHidden-methods

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

Print a workbook's filename
setCellFormula-methods

Setting cell formulas
renameSheet-methods

Renaming worksheets from workbooks
normalizeDataframe

Data frame Normalization for Unit Tests
setMissingValue-methods

Setting missing value identifiers
readWorksheetFromFile

Reading data from worksheets in an Excel file (wrapper function)
readNamedRegion

Reading named regions from a workbook
idx2col

Converting column indices to Excel column names
readNamedRegionFromFile

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

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

Removing names from workbooks
idx2cref

Converting indices to Excel cell references
isSheetVisible-methods

Checking if worksheets are visible in a workbook
setFillBackgroundColor-methods

Specifying the fill background color for cell styles
setDataFormatForType-methods

Setting the data format for the DATA_FORMAT_ONLY style action
jTryCatch

Standard Java exception handling for XLConnect
setFillForegroundColor-methods

Specifying the fill foreground color for cell styles
with.workbook

Evaluate an R expression in a workbook environment
workbook-class

Class "workbook"
setColumnWidth-methods

Setting the width of a column in a worksheet
writeNamedRegionToFile

Writing named regions to an Excel file (wrapper function)
saveWorkbook-methods

Saving Microsoft Excel workbooks
writeWorksheet-methods

Writing data to worksheets
setDataFormat-methods

Specifying custom data formats for cell styles
setActiveSheet-methods

Setting the active worksheet in a workbook
setSheetColor-methods

Setting colors on worksheet tabs
setSheetPos-methods

Setting worksheet position
setFillPattern-methods

Specifying the fill pattern for cell styles
unhideSheet-methods

Unhiding worksheets in a workbook
wrapList

Wrapping of arguments in a list
writeNamedRegion-methods

Writing named regions to a workbook
setAutoFilter-methods

Setting auto-filters on worksheets
setStyleAction-methods

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

Unmerging cells
xlcDump

Dumping data sets to Excel files
readTable

Reading Excel tables from a workbook
xlcRestore

Restoring objects from Excel files
setStyleNamePrefix-methods

Setting the style name prefix for the "name prefix" style action
readWorksheet-methods

Reading data from worksheets
xlcEdit

Editing data sets in an Excel file editor
setWrapText-methods

Specifying text wrapping behaviour
show-methods

Display a workbook object
xlcFreeMemory

Freeing Java Virtual Machine memory
xlcMemoryReport

Reporting free Java Virtual Machine memory
setCellStyle-methods

Setting cell styles
setCellStyleForType-methods

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

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

Setting hyperlinks
summary-methods

Summarizing workbook objects
swissfranc

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

Writing data to worksheets in an Excel file (wrapper function)
xlcCall

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