R: Create a named region.

createNamedRegion {openxlsx} | R Documentation

## Create a named region.

### Description

Create a named region

### Usage

    createNamedRegion(wb, sheet, cols, rows, name)

### Arguments

`wb` | A workbook object
`sheet` | A name or index of a worksheet
`cols` | Numeric vector specifying columns to include in region
`rows` | Numeric vector specifying rows to include in region
`name` | Name for region. A character vector of length 1. Note region names musts be case-insensitive unique.

### Details

Region is given by: min(cols):max(cols) X min(rows):max(rows)

### Author(s)

Alexander Walker

### See Also

`getNamedRegions`

### Examples

    ## create named regions
    wb <- createWorkbook()
    addWorksheet(wb, "Sheet 1")

    ## specify region
    writeData(wb, sheet = 1, x = iris, startCol = 1, startRow = 1)
    createNamedRegion(wb = wb,
                      sheet = 1,
                      name = "iris",
                      rows = 1:(nrow(iris)+1),
                      cols = 1:ncol(iris))

    ## using writeData 'name' argument
    writeData(wb, sheet = 1, x = iris, name = "iris2", startCol = 10)

    out_file <- tempfile(fileext = ".xlsx")
    saveWorkbook(wb, out_file, overwrite = TRUE)

    ## see named regions
    getNamedRegions(wb) ## From Workbook object
    getNamedRegions(out_file) ## From xlsx file

    ## read named regions
    df <- read.xlsx(wb, namedRegion = "iris")
    head(df)

    df <- read.xlsx(out_file, namedRegion = "iris2")
    head(df)

[Package openxlsx version 4.0.17 Index]