openxlsx (version 1.0.3)

renameWorksheet: Rename an exisiting worksheet

Description

Rename an exisiting worksheet

Usage

renameWorksheet(wb, sheet, newName)

Arguments

wb

A Workbook object containing a worksheet

sheet

The name or index of the worksheet to rename

newName

The new name of the worksheet. No longer than 28 chars.

Examples

## Create a new workbook
wb <- createWorkbook("CREATOR")

## Add 3 worksheets
addWorksheet(wb, "Worksheet Name")
addWorksheet(wb, "This is worksheet 2")
addWorksheet(wb, "Not the best name")

## Rename worksheet 1
renameWorksheet(wb, 1, "New name for sheet 1")

## Rename worksheet 3
renameWorksheet(wb, "Not the best name", "A better name")

## Save workbook
saveWorkbook(wb, "renameWorksheetExample.xlsx", overwrite = TRUE)