appendNamedRegion-methods.Rd
Appends data to an existing named region.
# S4 method for class 'workbook,ANY'
appendNamedRegion(object,data,name,header,overwriteFormulaCells,rownames,worksheetScope)
The workbook
to use
Data to write
Name of the (existing) named region to which to append the data
Specifies if the column names should be written. The default is FALSE
.
Specifies if existing formula cells in the workbook
should be overwritten. The default is TRUE
.
Name (character
) of column to use for the row names of the provided
data
object. If specified, the row names of the data object (data.frame
) will be
included as an additional column with the specified name. If rownames = NULL
(default),
no row names will be included.
Optional character vector with worksheet name(s) to target a name
defined in the specified sheet(s) only. If not specified, the first matching named region is
appended to. Use ""
to specifically target a globally-scoped named region.
Appends data
to the existing named region specified by name
. The data
is
appended at the bottom of the named region. See writeNamedRegion
for further information on writing named regions.
Named regions are automatically redefined to the area occupied by the
previous and the newly appended data. This guarantees that the complete set
of data can be re-read using readNamedRegion
.
Note however, that no checks are performed to see whether the appended data has the
same shape/structure as the previous data.
if (FALSE) { # \dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")
# Load workbook
wb <- loadWorkbook(demoExcelFile)
# Append mtcars data set to named region named 'mtcars'
appendNamedRegion(wb, mtcars, name = "mtcars")
} # }