cellranger (version 1.0.0)

cell_limits: Create a cell_limits object

Description

The expectation is that as.cell_limits will be called to process user-provided input specifying the target cell range for read/write operations on a spreadsheet. Downstream code can be written assuming cell limits are stored in a valid cell_limits object.

Usage

cell_limits(ul = c(NA_integer_, NA_integer_), lr = c(NA_integer_, NA_integer_))
"dim"(x)
as.cell_limits(x)
"as.cell_limits"(x)
"as.cell_limits"(x)
"as.cell_limits"(x)

Arguments

ul

vector identifying upper left cell of target rectangle

lr

vector identifying lower right cell of target rectangle

x

input to convert into a cell_limits object

Value

a cell_limits object

Details

A cell_limits object is a list with two components:

• ul vector specifying upper left cell of target rectangle, of the form c(ROW_MIN, COL_MIN)
• lr vector specifying lower right cell of target rectangle, of the form c(ROW_MAX, COL_MAX)

This follows the spreadsheet convention where a cell range is described as UPPER_LEFT_CELL:LOWER_RIGHT_CELL. For rows and columns, the associated MIN and MAX are positive integers, where the minimum should be less than or equal to the maximum. A value of NA means the corresponding limit is left unspecified. Therefore a verbose way to specify no limits at all would be cell_limits(c(NA, NA), c(NA, NA)). If the maximum row or column is specified but the associated minimum is not, then the minimum it is set to 1.

When specified via character, spreadsheet ranges can be given in "A1" notation or "R1C1" notation and dollar signs will be ignored, i.e. "A$1:$B$32" is equivalent to "A1:B32".

Examples

cell_limits(c(1, 3), c(1, 5))
cell_limits(c(NA, 7), c(3, NA))
cell_limits(c(NA, 7))
cell_limits(lr = c(3, 7))

dim(as.cell_limits("A1:F10"))
as.cell_limits("A1")
as.cell_limits("Q24")
as.cell_limits("A1:D8")
as.cell_limits("R5C11")
as.cell_limits("R2C3:R6C9")