XLConnect (version 1.1.0)

cloneSheet-methods: Cloning/copying worksheets

Description

Clones (copies) a worksheet in a workbook.

Usage

# S4 method for workbook,numeric
cloneSheet(object,sheet,name)
# S4 method for workbook,character
cloneSheet(object,sheet,name)

Arguments

object

The workbook to use

sheet

The name or index of the worksheet to clone

name

The name to assign to the cloned worksheet. Throws an exception if the name to assign is the name of an already existing worksheet.

Author

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

Details

If any worksheet-scoped named ranges are present on the original sheet, these named ranges will not be present on the cloned worksheet.

See Also

workbook, createSheet, removeSheet, renameSheet, getSheets, existsSheet

Examples

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

# Load workbook
wb <- loadWorkbook(demoExcelFile)

# Clone the 'mtcars' worksheet and assign it the name 'mtcars cloned'
cloneSheet(wb, sheet = "mtcars", name = "mtcars cloned")
}