R/write_sheet.R

In carleshf/loadxls: Easy reading and writing MS Excel files from R

#' Write single object to a MS Excel File
#'
#' Given a single \code{data.frame}, it saves it as sheet in a MS Excel File.
#'
#' @param data \code{data.frame} to be saved as sheet in a MS Excel File.
#' @param sheetname Name to be given to the sheet.
#' @param filename The path and the name to the MS Excel File.
#' @param replace If set to \code{TRUE} it replaces the content of the
#' given sheet with the current value of \code{data}.
#' @param include.rownames If set to \code{TRUE} adds the \code{data.frame}'s
#' rownames as a new column in the sheet.
#' @param verbose If set to \code{TRUE} useful messages are shown.
#' @export write_sheet
write_sheet <- function(data, sheetname, filename, include.rownames=FALSE, replace=FALSE,
                        verbose=TRUE) {
    wb <- XLConnect::loadWorkbook(filename, create=TRUE)
    if(include.rownames) {
        if(verbose) {
            message("Including data.frame's rownames to '", sheetname, "'.")
        }
        cn <- colnames(data)   
        data$row.names.loadxls <- rownames(data)
        data <- data[ , c("row.names.loadxls", cn)]
        colnames(data) <- c("", cn)
    }
    sheets <- XLConnect::getSheets(wb)
    if(!replace & (sheetname %in% sheets)) {
        stop("Given sheet's name '", sheetname, "' already exists.")
    }
    XLConnect::createSheet(wb, name=sheetname)
    XLConnect::writeWorksheet(wb, data=data, sheet=sheetname, header=TRUE)
    XLConnect::saveWorkbook(wb)
}