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

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

Copy Link

Version

Install

install.packages('XLConnect')

Monthly Downloads

6,557

Version

1.0.5

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Martin Studer

Last Published

October 1st, 2021

Functions in XLConnect (1.0.5)

cellstyle-class

Class "cellstyle"
XLConnect-package

Excel Connector for R
XLConnectSettings

Performing general settings for XLConnect
aref2idx

Converting Excel cell references to row and column based cell references
addImage-methods

Adding images to a worksheet
appendNamedRegion-methods

Appending data to a named region
XLConnect-deprecated

Deprecated functions in package XLConnect
aref

Constructing Excel area references
XLC

XLConnect Constants
appendWorksheet-methods

Appending data to worksheets
clearRangeFromReference-methods

Clearing cell ranges in a workbook
clearNamedRegion-methods

Clearing named regions in a workbook
clearRange-methods

Clearing cell ranges in a workbook
createSheet-methods

Creating worksheets in a workbook
extractSheetName

Extracting the sheet name from a formula
createName-methods

Creating names in a workbook
col2idx

Converting Excel column names to indices
cloneSheet-methods

Cloning/copying worksheets
createFreezePane-methods

Creating a freeze pane on a worksheet
getActiveSheetIndex-methods

Querying the active worksheet index
createCellStyle-methods

Creating custom named and anonymous cell styles
$-methods

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

Hiding worksheets in a workbook
clearSheet-methods

Clearing worksheets in a workbook
getLastColumn-methods

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

Retrieving named cell styles
createSplitPane-methods

Creating a split pane on a worksheet
getActiveSheetName-methods

Querying the active worksheet name
getLastRow-methods

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

Workbook data extraction & replacement operators
getDefinedNames-methods

Retrieving defined names in a workbook
existsName-methods

Checking existence of names in a workbook
existsSheet-methods

Checking for existence of worksheets in a workbook
cref2idx

Converting Excel cell references to indices
existsCellStyle-methods

Retrieving named cell styles
getBoundingBox-methods

Querying the coordinates of a worksheet bounding box
getCellFormula-methods

Retrieving formula definitions from cells
isSheetVisible-methods

Checking if worksheets are visible in a workbook
idx2aref

Converting row and column based area references to Excel area references
getReferenceCoordinates-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
getForceFormulaRecalculation-methods

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

Querying available worksheets in a workbook
print-methods

Print a workbook's filename
jTryCatch

Standard Java exception handling for XLConnect
getOrCreateCellStyle-methods

Retrieving or creating named cell styles
onErrorCell-methods

Behavior when error cells are detected
getReferenceFormula-methods

Querying reference formulas of Excel names
renameSheet-methods

Renaming worksheets from workbooks
idx2col

Converting column indices to Excel column names
saveWorkbook-methods

Saving Microsoft Excel workbooks
getTables-methods

Querying available Excel tables in a workbook
setColumnWidth-methods

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

Checking if worksheets are hidden in a workbook
isSheetVeryHidden-methods

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

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

Specifying custom data formats for cell styles
setSheetColor-methods

Setting colors on worksheet tabs
setCellStyle-methods

Setting cell styles
getReferenceCoordinatesForTable-methods

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

Specifying text wrapping behaviour
readTable

Reading Excel tables from a workbook
setBorder-methods

Specifying borders for cell styles
setCellStyleForType-methods

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

Display a workbook object
loadWorkbook

Loading Microsoft Excel workbooks
setMissingValue-methods

Setting missing value identifiers
setRowHeight-methods

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

Querying worksheet position
xlcFreeMemory

Freeing Java Virtual Machine memory
summary-methods

Summarizing workbook objects
workbook-class

Class "workbook"
readNamedRegion

Reading named regions from a workbook
xlcMemoryReport

Reporting free Java Virtual Machine memory
setSheetPos-methods

Setting worksheet position
idx2cref

Converting indices to Excel cell references
with.workbook

Evaluate an R expression in a workbook environment
mergeCells-methods

Merging cells
readNamedRegionFromFile

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

Setting cell formulas
readWorksheet-methods

Reading data from worksheets
setActiveSheet-methods

Setting the active worksheet in a workbook
mirai

Mirai Solutions GmbH
writeNamedRegionToFile

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

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

Data frame Normalization for Unit Tests
setAutoFilter-methods

Setting auto-filters on worksheets
removePane-methods

Removing panes from worksheet
removeName-methods

Removing names from workbooks
readWorksheetFromFile

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

Dumping data sets to Excel files
xlcEdit

Editing data sets in an Excel file editor
setStyleAction-methods

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

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

Writing data to worksheets
setForceFormulaRecalculation-methods

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

Setting hyperlinks
removeSheet-methods

Removing worksheets from workbooks
setDataFormatForType-methods

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

Unhiding worksheets in a workbook
setFillBackgroundColor-methods

Specifying the fill background color for cell styles
unmergeCells-methods

Unmerging cells
setFillPattern-methods

Specifying the fill pattern for cell styles
xlcRestore

Restoring objects from Excel files
setFillForegroundColor-methods

Specifying the fill foreground color for cell styles
writeNamedRegion-methods

Writing named regions to a workbook
xlcCall

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

Wrapping of arguments in a list
writeWorksheetToFile

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