Package: XLConnect 1.1.0

Martin Studer

XLConnect: Excel Connector for R

Provides comprehensive functionality to read, write and format Excel data.

Authors:Mirai Solutions GmbH [aut], Martin Studer [cre], The Apache Software Foundation [ctb, cph], Graph Builder [ctb, cph], Brett Woolridge [ctb, cph]

XLConnect_1.1.0.tar.gz
XLConnect_1.1.0.zip(r-4.5)XLConnect_1.1.0.zip(r-4.4)XLConnect_1.1.0.zip(r-4.3)
XLConnect_1.1.0.tgz(r-4.4-any)XLConnect_1.1.0.tgz(r-4.3-any)
XLConnect_1.1.0.tar.gz(r-4.5-noble)XLConnect_1.1.0.tar.gz(r-4.4-noble)
XLConnect_1.1.0.tgz(r-4.4-emscripten)XLConnect_1.1.0.tgz(r-4.3-emscripten)
XLConnect.pdf |XLConnect.html
XLConnect/json (API)
NEWS

# Install 'XLConnect' in R:
install.packages('XLConnect', repos = c('https://miraisolutions.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/miraisolutions/xlconnect/issues

Uses libs:
  • openjdk– OpenJDK Java runtime, using Hotspot JIT
Datasets:
  • swissfranc - Historical Exchange Rates: CHF vs EUR, USD and GBP

On CRAN:

cross-platformexcelr-languagexlconnect

97 exports 130 stars 5.22 score 1 dependencies 1 dependents 8 mentions 1.2k scripts 8.2k downloads

Last updated 27 days agofrom:b99ea5af43. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKAug 22 2024
R-4.5-winOKAug 22 2024
R-4.5-linuxOKAug 22 2024
R-4.4-winOKAug 22 2024
R-4.4-macOKAug 22 2024
R-4.3-winOKAug 22 2024
R-4.3-macOKAug 22 2024

Exports:addImageappendNamedRegionappendWorksheetarefaref2idxclearNamedRegionclearRangeclearRangeFromReferenceclearSheetcloneSheetcol2idxcreateCellStylecreateFreezePanecreateNamecreateSheetcreateSplitPanecref2idxexistsCellStyleexistsNameexistsSheetextractSheetNamegetActiveSheetIndexgetActiveSheetNamegetBoundingBoxgetCellFormulagetCellStylegetCellStyleForTypegetDefinedNamesgetForceFormulaRecalculationgetLastColumngetLastRowgetOrCreateCellStylegetReferenceCoordinatesgetReferenceCoordinatesForNamegetReferenceCoordinatesForTablegetReferenceFormulagetSheetPosgetSheetsgetTableshideSheetidx2arefidx2colidx2crefisSheetHiddenisSheetVeryHiddenisSheetVisibleloadWorkbookmergeCellsmirainormalizeDataframeonErrorCellprintreadNamedRegionreadNamedRegionFromFilereadTablereadWorksheetreadWorksheetFromFileremoveNameremovePaneremoveSheetrenameSheetsaveWorkbooksetActiveSheetsetAutoFiltersetBordersetCellFormulasetCellStylesetCellStyleForTypesetColumnWidthsetDataFormatsetDataFormatForTypesetFillBackgroundColorsetFillForegroundColorsetFillPatternsetForceFormulaRecalculationsetHyperlinksetMissingValuesetRowHeightsetSheetColorsetSheetPossetStyleActionsetStyleNamePrefixsetWrapTextshowsummaryunhideSheetunmergeCellswriteNamedRegionwriteNamedRegionToFilewriteWorksheetwriteWorksheetToFileXLCxlcDumpxlcEditxlcFreeMemoryxlcMemoryReportxlcRestore

Dependencies:rJava

The XLConnect Package

Rendered fromXLConnect.Rnwusingutils::Sweaveon Aug 22 2024.

Last update: 2024-08-21
Started: 2013-11-13

XLConnect for the Impatient

Rendered fromXLConnectImpatient.Rnwusingutils::Sweaveon Aug 22 2024.

Last update: 2021-12-30
Started: 2013-11-13

Readme and manuals

Help Manual

Help pageTopics
Excel Connector for RXLConnect-package XLConnect
Executing workbook methods in object$method(...) form$ $,cellstyle-method $,workbook-method $-methods
Adding images to a worksheetaddImage addImage,workbook-method addImage-methods
Appending data to a named regionappendNamedRegion appendNamedRegion,workbook,ANY-method appendNamedRegion,workbook-method appendNamedRegion-methods
Appending data to worksheetsappendWorksheet appendWorksheet,workbook,ANY,character-method appendWorksheet,workbook,ANY,numeric-method appendWorksheet-methods
Constructing Excel area referencesaref
Converting Excel cell references to row and column based cell referencesaref2idx
Class "cellstyle"cellstyle-class
Clearing named regions in a workbookclearNamedRegion clearNamedRegion,workbook,character-method clearNamedRegion-methods
Clearing cell ranges in a workbookclearRange clearRange,workbook,character-method clearRange,workbook,numeric-method clearRange-methods
Clearing cell ranges in a workbookclearRangeFromReference clearRangeFromReference,workbook,character-method clearRangeFromReference-methods
Clearing worksheets in a workbookclearSheet clearSheet,workbook,character-method clearSheet,workbook,numeric-method clearSheet-methods
Cloning/copying worksheetscloneSheet cloneSheet,workbook,character-method cloneSheet,workbook,numeric-method cloneSheet-methods
Converting Excel column names to indicescol2idx
Creating custom named and anonymous cell stylescreateCellStyle createCellStyle,workbook,character-method createCellStyle,workbook,missing-method createCellStyle-methods
Creating a freeze pane on a worksheetcreateFreezePane createFreezePane,workbook,character-method createFreezePane,workbook,numeric-method createFreezePane-methods
Creating names in a workbookcreateName createName,workbook-method createName-methods
Creating worksheets in a workbookcreateSheet createSheet,workbook-method createSheet-methods
Creating a split pane on a worksheetcreateSplitPane createSplitPane,workbook,character-method createSplitPane,workbook,numeric-method createSplitPane-methods
Converting Excel cell references to indicescref2idx
Retrieving named cell stylesexistsCellStyle existsCellStyle,workbook-method existsCellStyle-methods
Checking existence of named ranges in a workbookexistsName existsName,workbook-method existsName-methods
Checking for existence of worksheets in a workbookexistsSheet existsSheet,workbook-method existsSheet-methods
Workbook data extraction & replacement operators[ [,workbook-method [-methods [<- [<-,workbook-method [<--methods [[ [[,workbook-method [[-methods [[<- [[<-,workbook-method [[<--methods
Extracting the sheet name from a formulaextractSheetName
Querying the active worksheet indexgetActiveSheetIndex getActiveSheetIndex,workbook-method getActiveSheetIndex-methods
Querying the active worksheet namegetActiveSheetName getActiveSheetName,workbook-method getActiveSheetName-methods
Querying the coordinates of a worksheet bounding boxgetBoundingBox getBoundingBox,workbook,character-method getBoundingBox,workbook,numeric-method getBoundingBox-methods
Retrieving formula definitions from cellsgetCellFormula getCellFormula,workbook,character-method getCellFormula,workbook,numeric-method getCellFormula-methods
Retrieving named cell stylesgetCellStyle getCellStyle,workbook-method getCellStyle-methods
Querying the cell style per data type for the DATATYPE style actiongetCellStyleForType getCellStyleForType,workbook-method getCellStyleForType-methods
Retrieving defined names in a workbookgetDefinedNames getDefinedNames,workbook-method getDefinedNames-methods
Querying the coordinates of the range reference by an Excel namegetForceFormulaRecalculation getForceFormulaRecalculation,workbook,character-method getForceFormulaRecalculation,workbook,numeric-method getForceFormulaRecalculation-methods
Querying the last (non-empty) column on a worksheetgetLastColumn getLastColumn,workbook,character-method getLastColumn,workbook,numeric-method getLastColumn-methods
Querying the last (non-empty) row on a worksheetgetLastRow getLastRow,workbook,character-method getLastRow,workbook,numeric-method getLastRow-methods
Retrieving or creating named cell stylesgetOrCreateCellStyle getOrCreateCellStyle,workbook,character-method getOrCreateCellStyle-methods
Querying the coordinates of the range reference by an Excel namegetReferenceCoordinates getReferenceCoordinates,workbook-method getReferenceCoordinates-methods
Querying the coordinates of the range reference by an Excel namegetReferenceCoordinatesForName getReferenceCoordinatesForName,workbook-method getReferenceCoordinatesForName-methods
Querying the coordinates of the range of an Excel tablegetReferenceCoordinatesForTable getReferenceCoordinatesForTable,workbook,character-method getReferenceCoordinatesForTable,workbook,numeric-method getReferenceCoordinatesForTable-methods
Querying reference formulas of Excel namesgetReferenceFormula getReferenceFormula,workbook-method getReferenceFormula-methods
Querying worksheet positiongetSheetPos getSheetPos,workbook,character-method getSheetPos-methods
Querying available worksheets in a workbookgetSheets getSheets,workbook-method getSheets-methods
Querying available Excel tables in a workbookgetTables getTables,workbook,character-method getTables,workbook,numeric-method getTables-methods
Hiding worksheets in a workbookhideSheet hideSheet,workbook,character-method hideSheet,workbook,numeric-method hideSheet-methods
Converting row and column based area references to Excel area referencesidx2aref
Converting column indices to Excel column namesidx2col
Converting indices to Excel cell referencesidx2cref
Checking if worksheets are hidden in a workbookisSheetHidden isSheetHidden,workbook,character-method isSheetHidden,workbook,numeric-method isSheetHidden-methods
Checking if worksheets are very hidden in a workbookisSheetVeryHidden isSheetVeryHidden,workbook,character-method isSheetVeryHidden,workbook,numeric-method isSheetVeryHidden-methods
Checking if worksheets are visible in a workbookisSheetVisible isSheetVisible,workbook,character-method isSheetVisible,workbook,numeric-method isSheetVisible-methods
Loading Microsoft Excel workbooksloadWorkbook
Merging cellsmergeCells mergeCells,workbook,character-method mergeCells,workbook,numeric-method mergeCells-methods
Mirai Solutions GmbHmirai
Behavior when error cells are detectedonErrorCell onErrorCell,workbook-method onErrorCell-methods
Print a workbook's filenameprint print,workbook-method print-methods
Reading named regions from a workbookreadNamedRegion readNamedRegion,workbook-method readNamedRegion-methods
Reading named regions from an Excel file (wrapper function)readNamedRegionFromFile
Reading Excel tables from a workbookreadTable readTable,workbook,character-method readTable,workbook,numeric-method readTable-methods
Reading data from worksheetsreadWorksheet readWorksheet,workbook,character-method readWorksheet,workbook,numeric-method readWorksheet-methods
Reading data from worksheets in an Excel file (wrapper function)readWorksheetFromFile
Removing names from workbooksremoveName removeName,workbook-method removeName-methods
Removing panes from worksheetremovePane removePane,workbook,character-method removePane,workbook,numeric-method removePane-methods
Removing worksheets from workbooksremoveSheet removeSheet,workbook,character-method removeSheet,workbook,numeric-method removeSheet-methods
Renaming worksheets from workbooksrenameSheet renameSheet,workbook,character-method renameSheet,workbook,numeric-method renameSheet-methods
Saving Microsoft Excel workbookssaveWorkbook saveWorkbook,workbook,character-method saveWorkbook,workbook,missing-method saveWorkbook-methods
Setting the active worksheet in a workbooksetActiveSheet setActiveSheet,workbook,character-method setActiveSheet,workbook,numeric-method setActiveSheet-methods
Setting auto-filters on worksheetssetAutoFilter setAutoFilter,workbook,character-method setAutoFilter,workbook,numeric-method setAutoFilter-methods
Specifying borders for cell stylessetBorder setBorder,cellstyle-method setBorder-methods
Setting cell formulassetCellFormula setCellFormula,workbook,character-method setCellFormula,workbook,numeric-method setCellFormula-methods
Setting cell stylessetCellStyle setCellStyle,workbook,character,missing-method setCellStyle,workbook,missing,character-method setCellStyle,workbook,missing,numeric-method setCellStyle-methods
Setting the cell style per data type for the DATATYPE style actionsetCellStyleForType setCellStyleForType,workbook-method setCellStyleForType-methods
Setting the width of a column in a worksheetsetColumnWidth setColumnWidth,workbook,character-method setColumnWidth,workbook,numeric-method setColumnWidth-methods
Specifying custom data formats for cell stylessetDataFormat setDataFormat,cellstyle-method setDataFormat-methods
Setting the data format for the DATA_FORMAT_ONLY style actionsetDataFormatForType setDataFormatForType,workbook-method setDataFormatForType-methods
Specifying the fill background color for cell stylessetFillBackgroundColor setFillBackgroundColor,cellstyle,numeric-method setFillBackgroundColor-methods
Specifying the fill foreground color for cell stylessetFillForegroundColor setFillForegroundColor,cellstyle,numeric-method setFillForegroundColor-methods
Specifying the fill pattern for cell stylessetFillPattern setFillPattern,cellstyle-method setFillPattern-methods
Forcing Excel to recalculate formula values when opening a workbooksetForceFormulaRecalculation setForceFormulaRecalculation,workbook,character-method setForceFormulaRecalculation,workbook,numeric-method setForceFormulaRecalculation-methods
Setting hyperlinkssetHyperlink setHyperlink,workbook,character,missing-method setHyperlink,workbook,missing,character-method setHyperlink,workbook,missing,numeric-method setHyperlink-methods
Setting missing value identifierssetMissingValue setMissingValue,workbook,ANY-method setMissingValue,workbook-method setMissingValue-methods
Setting the height of a row in a worksheetsetRowHeight setRowHeight,workbook,character-method setRowHeight,workbook,numeric-method setRowHeight-methods
Setting colors on worksheet tabssetSheetColor setSheetColor,workbook,character-method setSheetColor,workbook,numeric-method setSheetColor-methods
Setting worksheet positionsetSheetPos setSheetPos,workbook,character,missing-method setSheetPos,workbook,character,numeric-method setSheetPos-methods
Controlling application of cell styles when writing data to ExcelsetStyleAction setStyleAction,workbook-method setStyleAction-methods
Setting the style name prefix for the "name prefix" style actionsetStyleNamePrefix setStyleNamePrefix,workbook-method setStyleNamePrefix-methods
Specifying text wrapping behavioursetWrapText setWrapText,cellstyle-method setWrapText-methods
Display a workbook objectshow show,workbook-method show-methods
Summarizing workbook objectssummary summary,workbook-method summary-methods
Historical Exchange Rates: CHF vs EUR, USD and GBPswissfranc
Unhiding worksheets in a workbookunhideSheet unhideSheet,workbook,character-method unhideSheet,workbook,numeric-method unhideSheet-methods
Unmerging cellsunmergeCells unmergeCells,workbook,character-method unmergeCells,workbook,numeric-method unmergeCells-methods
Evaluate an R expression in a workbook environmentwith.workbook
Class "workbook"workbook-class
Writing named regions to a workbookwriteNamedRegion writeNamedRegion,workbook,ANY-method writeNamedRegion,workbook-method writeNamedRegion-methods
Writing named regions to an Excel file (wrapper function)writeNamedRegionToFile
Writing data to worksheetswriteWorksheet writeWorksheet,workbook,ANY,character-method writeWorksheet,workbook,ANY,numeric-method writeWorksheet-methods
Writing data to worksheets in an Excel file (wrapper function)writeWorksheetToFile
XLConnect ConstantsXLC
Dumping data sets to Excel filesxlcDump
Editing data sets in an Excel file editorxlcEdit
Freeing Java Virtual Machine memoryxlcFreeMemory
Reporting free Java Virtual Machine memoryxlcMemoryReport
Deprecated functions in package 'XLConnect'XLConnect-deprecated
Restoring objects from Excel filesxlcRestore