# Excel Connector for R

## Documentation for package ‘XLConnect’ version 1.3.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Code demos. Use demo() to run them.
- Package NEWS.

## Help Pages

A C E G H I L M O P R S U W X misc

XLConnect-package | Excel Connector for R

## -- A --

addImage | Adding images to a worksheet
addImage-method | Adding images to a worksheet
addImage-methods | Adding images to a worksheet
appendNamedRegion | Appending data to a named region
appendNamedRegion-method | Appending data to a named region
appendNamedRegion-methods | Appending data to a named region
appendWorksheet | Appending data to worksheets
appendWorksheet-method | Appending data to worksheets
appendWorksheet-methods | Appending data to worksheets
aref | Constructing Excel area references
aref2idx | Converting Excel cell references to row and column based cell references

## -- C --

cellstyle-class | Class "cellstyle"
clearNamedRegion | Clearing named regions in a workbook
clearNamedRegion-method | Clearing named regions in a workbook
clearNamedRegion-methods | Clearing named regions in a workbook
clearRange | Clearing cell ranges in a workbook
clearRange-method | Clearing cell ranges in a workbook
clearRange-methods | Clearing cell ranges in a workbook
clearRangeFromReference | Clearing cell ranges in a workbook
clearRangeFromReference-method | Clearing cell ranges in a workbook
clearRangeFromReference-methods | Clearing cell ranges in a workbook
clearSheet | Clearing worksheets in a workbook
clearSheet-method | Clearing worksheets in a workbook
clearSheet-methods | Clearing worksheets in a workbook
cloneSheet | Cloning/copying worksheets
cloneSheet-method | Cloning/copying worksheets
cloneSheet-methods | Cloning/copying worksheets
col2idx | Converting Excel column names to indices
configurePOI | Configuring Apache POI
createCellStyle | Creating custom named and anonymous cell styles
createCellStyle-method | Creating custom named and anonymous cell styles
createCellStyle-methods | Creating custom named and anonymous cell styles
createFreezePane | Creating a freeze pane on a worksheet
createFreezePane-method | Creating a freeze pane on a worksheet
createFreezePane-methods | Creating a freeze pane on a worksheet
createName | Creating names in a workbook
createName-method | Creating names in a workbook
createName-methods | Creating names in a workbook
createSheet | Creating worksheets in a workbook
createSheet-method | Creating worksheets in a workbook
createSheet-methods | Creating worksheets in a workbook
createSplitPane | Creating a split pane on a worksheet
createSplitPane-method | Creating a split pane on a worksheet
createSplitPane-methods | Creating a split pane on a worksheet
cref2idx | Converting Excel cell references to indices

## -- E --

existsCellStyle | Retrieving named cell styles
existsCellStyle-method | Retrieving named cell styles
existsCellStyle-methods | Retrieving named cell styles
existsName | Checking existence of named ranges in a workbook
existsName-method | Checking existence of named ranges in a workbook
existsName-methods | Checking existence of named ranges in a workbook
existsSheet | Checking for existence of worksheets in a workbook
existsSheet-method | Checking for existence of worksheets in a workbook
existsSheet-methods | Checking for existence of worksheets in a workbook
extractSheetName | Extracting the sheet name from a formula

## -- G --

getActiveSheetIndex | Querying the active worksheet index
getActiveSheetIndex-method | Querying the active worksheet index
getActiveSheetIndex-methods | Querying the active worksheet index
getActiveSheetName | Querying the active worksheet name
getActiveSheetName-method | Querying the active worksheet name
getActiveSheetName-methods | Querying the active worksheet name
getBoundingBox | Querying the coordinates of a worksheet bounding box
getBoundingBox-method | Querying the coordinates of a worksheet bounding box
getBoundingBox-methods | Querying the coordinates of a worksheet bounding box
getCellFormula | Retrieving formula definitions from cells
getCellFormula-method | Retrieving formula definitions from cells
getCellFormula-methods | Retrieving formula definitions from cells
getCellStyle | Retrieving named cell styles
getCellStyle-method | Retrieving named cell styles
getCellStyle-methods | Retrieving named cell styles
getCellStyleForType | Querying the cell style per data type for the DATATYPE style action
getCellStyleForType-method | Querying the cell style per data type for the DATATYPE style action
getCellStyleForType-methods | Querying the cell style per data type for the DATATYPE style action
getDefinedNames | Retrieving defined names in a workbook
getDefinedNames-method | Retrieving defined names in a workbook
getDefinedNames-methods | Retrieving defined names in a workbook
getForceFormulaRecalculation | Querying the coordinates of the range reference by an Excel name
getForceFormulaRecalculation-method | Querying the coordinates of the range reference by an Excel name
getForceFormulaRecalculation-methods | Querying the coordinates of the range reference by an Excel name
getLastColumn | Querying the last (non-empty) column on a worksheet
getLastColumn-method | Querying the last (non-empty) column on a worksheet
getLastColumn-methods | Querying the last (non-empty) column on a worksheet
getLastRow | Querying the last (non-empty) row on a worksheet
getLastRow-method | Querying the last (non-empty) row on a worksheet
getLastRow-methods | Querying the last (non-empty) row on a worksheet
getOrCreateCellStyle | Retrieving or creating named cell styles
getOrCreateCellStyle-method | Retrieving or creating named cell styles
getOrCreateCellStyle-methods | Retrieving or creating named cell styles
getReferenceCoordinates | Querying the coordinates of the range reference by an Excel name
getReferenceCoordinates-method | Querying the coordinates of the range reference by an Excel name
getReferenceCoordinates-methods | Querying the coordinates of the range reference by an Excel name
getReferenceCoordinatesForName | Querying the coordinates of the range reference by an Excel name
getReferenceCoordinatesForName-method | Querying the coordinates of the range reference by an Excel name
getReferenceCoordinatesForName-methods | Querying the coordinates of the range reference by an Excel name
getReferenceCoordinatesForTable | Querying the coordinates of the range of an Excel table
getReferenceCoordinatesForTable-method | Querying the coordinates of the range of an Excel table
getReferenceCoordinatesForTable-methods | Querying the coordinates of the range of an Excel table
getReferenceFormula | Querying reference formulas of Excel names
getReferenceFormula-method | Querying reference formulas of Excel names
getReferenceFormula-methods | Querying reference formulas of Excel names
getSheetPos | Querying worksheet position
getSheetPos-method | Querying worksheet position
getSheetPos-methods | Querying worksheet position
getSheets | Querying available worksheets in a workbook
getSheets-method | Querying available worksheets in a workbook
getSheets-methods | Querying available worksheets in a workbook
getTables | Querying available Excel tables in a workbook
getTables-method | Querying available Excel tables in a workbook
getTables-methods | Querying available Excel tables in a workbook

## -- H --

hideSheet | Hiding worksheets in a workbook
hideSheet-method | Hiding worksheets in a workbook
hideSheet-methods | Hiding worksheets in a workbook

## -- I --

idx2aref | Converting row and column based area references to Excel area references
idx2col | Converting column indices to Excel column names
idx2cref | Converting indices to Excel cell references
isSheetHidden | Checking if worksheets are hidden in a workbook
isSheetHidden-method | Checking if worksheets are hidden in a workbook
isSheetHidden-methods | Checking if worksheets are hidden in a workbook
isSheetVeryHidden | Checking if worksheets are very hidden in a workbook
isSheetVeryHidden-method | Checking if worksheets are very hidden in a workbook
isSheetVeryHidden-methods | Checking if worksheets are very hidden in a workbook
isSheetVisible | Checking if worksheets are visible in a workbook
isSheetVisible-method | Checking if worksheets are visible in a workbook
isSheetVisible-methods | Checking if worksheets are visible in a workbook

## -- L --

loadWorkbook | Loading Microsoft Excel workbooks

## -- M --

mergeCells | Merging cells
mergeCells-method | Merging cells
mergeCells-methods | Merging cells
mirai | Mirai Solutions GmbH

## -- O --

onErrorCell | Behavior when error cells are detected
onErrorCell-method | Behavior when error cells are detected
onErrorCell-methods | Behavior when error cells are detected

## -- P --

print | Print a workbook's filename
print-method | Print a workbook's filename
print-methods | Print a workbook's filename

## -- R --

readNamedRegion | Reading named regions from a workbook
readNamedRegion-method | Reading named regions from a workbook
readNamedRegion-methods | Reading named regions from a workbook
readNamedRegionFromFile | Reading named regions from an Excel file (wrapper function)
readTable | Reading Excel tables from a workbook
readTable-method | Reading Excel tables from a workbook
readTable-methods | Reading Excel tables from a workbook
readWorksheet | Reading data from worksheets
readWorksheet-method | Reading data from worksheets
readWorksheet-methods | Reading data from worksheets
readWorksheetFromFile | Reading data from worksheets in an Excel file (wrapper function)
removeName | Removing names from workbooks
removeName-method | Removing names from workbooks
removeName-methods | Removing names from workbooks
removePane | Removing panes from worksheet
removePane-method | Removing panes from worksheet
removePane-methods | Removing panes from worksheet
removeSheet | Removing worksheets from workbooks
removeSheet-method | Removing worksheets from workbooks
removeSheet-methods | Removing worksheets from workbooks
renameSheet | Renaming worksheets from workbooks
renameSheet-method | Renaming worksheets from workbooks
renameSheet-methods | Renaming worksheets from workbooks

## -- S --

saveWorkbook | Saving Microsoft Excel workbooks
saveWorkbook-method | Saving Microsoft Excel workbooks
saveWorkbook-methods | Saving Microsoft Excel workbooks
setActiveSheet | Setting the active worksheet in a workbook
setActiveSheet-method | Setting the active worksheet in a workbook
setActiveSheet-methods | Setting the active worksheet in a workbook
setAutoFilter | Setting auto-filters on worksheets
setAutoFilter-method | Setting auto-filters on worksheets
setAutoFilter-methods | Setting auto-filters on worksheets
setBorder | Specifying borders for cell styles
setBorder-method | Specifying borders for cell styles
setBorder-methods | Specifying borders for cell styles
setCellFormula | Setting cell formulas
setCellFormula-method | Setting cell formulas
setCellFormula-methods | Setting cell formulas
setCellStyle | Setting cell styles
setCellStyle-method | Setting cell styles
setCellStyle-methods | Setting cell styles
setCellStyleForType | Setting the cell style per data type for the DATATYPE style action
setCellStyleForType-method | Setting the cell style per data type for the DATATYPE style action
setCellStyleForType-methods | Setting the cell style per data type for the DATATYPE style action
setColumnWidth | Setting the width of a column in a worksheet
setColumnWidth-method | Setting the width of a column in a worksheet
setColumnWidth-methods | Setting the width of a column in a worksheet
setDataFormat | Specifying custom data formats for cell styles
setDataFormat-method | Specifying custom data formats for cell styles
setDataFormat-methods | Specifying custom data formats for cell styles
setDataFormatForType | Setting the data format for the DATA_FORMAT_ONLY style action
setDataFormatForType-method | Setting the data format for the DATA_FORMAT_ONLY style action
setDataFormatForType-methods | Setting the data format for the DATA_FORMAT_ONLY style action
setFillBackgroundColor | Specifying the fill background color for cell styles
setFillBackgroundColor-method | Specifying the fill background color for cell styles
setFillBackgroundColor-methods | Specifying the fill background color for cell styles
setFillForegroundColor | Specifying the fill foreground color for cell styles
setFillForegroundColor-method | Specifying the fill foreground color for cell styles
setFillForegroundColor-methods | Specifying the fill foreground color for cell styles
setFillPattern | Specifying the fill pattern for cell styles
setFillPattern-method | Specifying the fill pattern for cell styles
setFillPattern-methods | Specifying the fill pattern for cell styles
setForceFormulaRecalculation | Forcing Excel to recalculate formula values when opening a workbook
setForceFormulaRecalculation-method | Forcing Excel to recalculate formula values when opening a workbook
setForceFormulaRecalculation-methods | Forcing Excel to recalculate formula values when opening a workbook
setHyperlink | Setting hyperlinks
setHyperlink-method | Setting hyperlinks
setHyperlink-methods | Setting hyperlinks
setMissingValue | Setting missing value identifiers
setMissingValue-method | Setting missing value identifiers
setMissingValue-methods | Setting missing value identifiers
setRowHeight | Setting the height of a row in a worksheet
setRowHeight-method | Setting the height of a row in a worksheet
setRowHeight-methods | Setting the height of a row in a worksheet
setSheetColor | Setting colors on worksheet tabs
setSheetColor-method | Setting colors on worksheet tabs
setSheetColor-methods | Setting colors on worksheet tabs
setSheetPos | Setting worksheet position
setSheetPos-method | Setting worksheet position
setSheetPos-methods | Setting worksheet position
setStyleAction | Controlling application of cell styles when writing data to Excel
setStyleAction-method | Controlling application of cell styles when writing data to Excel
setStyleAction-methods | Controlling application of cell styles when writing data to Excel
setStyleNamePrefix | Setting the style name prefix for the "name prefix" style action
setStyleNamePrefix-method | Setting the style name prefix for the "name prefix" style action
setStyleNamePrefix-methods | Setting the style name prefix for the "name prefix" style action
setWrapText | Specifying text wrapping behaviour
setWrapText-method | Specifying text wrapping behaviour
setWrapText-methods | Specifying text wrapping behaviour
show | Display a workbook object
show-method | Display a workbook object
show-methods | Display a workbook object
summary | Summarizing workbook objects
summary-method | Summarizing workbook objects
summary-methods | Summarizing workbook objects
swissfranc | Historical Exchange Rates: CHF vs EUR, USD and GBP

## -- U --

unhideSheet | Unhiding worksheets in a workbook
unhideSheet-method | Unhiding worksheets in a workbook
unhideSheet-methods | Unhiding worksheets in a workbook
unmergeCells | Unmerging cells
unmergeCells-method | Unmerging cells
unmergeCells-methods | Unmerging cells

## -- W --

with.workbook | Evaluate an R expression in a workbook environment
workbook-class | Class "workbook"
writeNamedRegion | Writing named regions to a workbook
writeNamedRegion-method | Writing named regions to a workbook
writeNamedRegion-methods | Writing named regions to a workbook
writeNamedRegionToFile | Writing named regions to an Excel file (wrapper function)
writeWorksheet | Writing data to worksheets
writeWorksheet-method | Writing data to worksheets
writeWorksheet-methods | Writing data to worksheets
writeWorksheetToFile | Writing data to worksheets in an Excel file (wrapper function)

## -- X --

XLC | XLConnect Constants
xlcDump | Dumping data sets to Excel files
xlcEdit | Editing data sets in an Excel file editor
xlcFreeMemory | Freeing Java Virtual Machine memory
xlcMemoryReport | Reporting free Java Virtual Machine memory
XLConnect | Excel Connector for R
XLConnect-deprecated | Deprecated functions in package 'XLConnect'
xlcRestore | Restoring objects from Excel files

## -- misc --

$ | Executing workbook methods in object$method(...) form
$-method | Executing workbook methods in object$method(...) form
$-methods | Executing workbook methods in object$method(...) form
[ | Workbook data extraction & replacement operators
[-method | Workbook data extraction & replacement operators
[-methods | Workbook data extraction & replacement operators
[<- | Workbook data extraction & replacement operators
[<--method | Workbook data extraction & replacement operators
[<--methods | Workbook data extraction & replacement operators
[[ | Workbook data extraction & replacement operators
[[-method | Workbook data extraction & replacement operators
[[-methods | Workbook data extraction & replacement operators
[[<- | Workbook data extraction & replacement operators
[[<--method | Workbook data extraction & replacement operators
[[<--methods | Workbook data extraction & replacement operators