XLConnect (version 0.1-7)

readWorksheet-methods: Reading data from worksheets

Description

Reads data from worksheets of a workbook.

Usage

## S3 method for class 'workbook,numeric':
readWorksheet(object,sheet,startRow,startCol,endRow,endCol,header,rownames)
## S3 method for class 'workbook,character':
readWorksheet(object,sheet,startRow,startCol,endRow,endCol,header,rownames)

Arguments

object

The workbook to use

sheet

The name or index of the worksheet to read from

startRow

The index of the first row to read from

startCol

The index of the first column to read from

endRow

The index of the last row to read from

endCol

The index of the last column to read from

header

Interpret the first row of the specified area as column headers. The default is TRUE.

rownames

Index (numeric) or name (character) of column that should be used as row names. The corresponding column will be removed from the data set. Defaults to NULL which means that no row names are applied.

Details

Reads data from the worksheet specified by sheet. Data is read starting at the top left corner specified by startRow and startCol down to the bottom right corner specified by endRow and endCol. If header = TRUE, the first row is interpreted as column names of the resulting data.frame. If startRow <= 0<="" code=""> then the first available (logical) row is assumed. If startCol <= 0<="" code=""> then the column of the first (logical) cell of the start row (startRow) is assumed. If endRow <= 0<="" code=""> then the last available (logical) row is assumed. If endCol <= 0<="" code=""> then the maximum column between startRow and endRow is assumed. In other words, if no boundaries are specified readWorksheet assumes the "bounding box" of the data as the corresponding boundaries. If all four coordinate arguments are missing this behaves as above with startRow = 0, startCol = 0, endRow = 0 and endCol = 0. In this case readWorksheet assumes the "bounding box" of the data as the corresponding boundaries. All arguments (except object) are vectorized. As such, multiple worksheets (and also multiple data regions from the same worksheet) can be read with one method call. If only one single data region is read, the return value is a data.frame. If multiple data regions are specified, the return value is a list of data.frame's returned in the order they have been specified.

See Also

workbook, writeWorksheet, readNamedRegion, writeNamedRegion, readWorksheetFromFile, onErrorCell

Examples

# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

# Load workbook
wb <- loadWorkbook(demoExcelFile)

# Read worksheet 'mtcars' (providing no specific area bounds;
# with default header = TRUE)
data <- readWorksheet(wb, sheet = "mtcars")