Renaming worksheets from workbooks

Renames a worksheet from a workbook.

# S4 method for class 'workbook,character'
renameSheet(object,sheet,newName)
# S4 method for class 'workbook,numeric'
renameSheet(object,sheet,newName)

Arguments

object

The workbook to use

sheet

The name or index of the sheet to rename

newName

The new name of the sheet

Author

Martin Studer
Mirai Solutions GmbH https://mirai-solutions.ch

Note

Note that renaming worksheets may result in invalid name references.

See also

workbook, createSheet, existsSheet, getSheets, removeSheet, cloneSheet, setActiveSheet

Examples

if (FALSE) { # \dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
mtcarsFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

# Load workbook
wb <- loadWorkbook(mtcarsFile)

# Rename the worksheet called 'mtcars' from the above file to 'MyCars'
renameSheet(wb, sheet = "mtcars", newName = "MyCars")
} # }