addWorksheet {openxlsx} | R Documentation

## Add a worksheet to a workbook

### Description

Add a worksheet to a Workbook object

### Usage

    addWorksheet(wb, sheetName, gridLines = TRUE, tabColour = NULL,
      zoom = 100, header = NULL, footer = NULL, evenHeader = NULL,
      evenFooter = NULL, firstHeader = NULL, firstFooter = NULL,
      visible = TRUE, paperSize = getOption("openxlsx.paperSize", default = 9),
      orientation = getOption("openxlsx.orientation", default = "portrait"),
      vdpi = getOption("openxlsx.vdpi", default = getOption("openxlsx.dpi",
      default = 300)), hdpi = getOption("openxlsx.hdpi", default =
      getOption("openxlsx.dpi", default = 300)))

### Arguments

`wb` | A Workbook object to attach the new worksheet
`sheetName` | A name for the new worksheet
`gridLines` | A logical. If `FALSE`, the worksheet grid lines will be hidden.
`tabColour` | Colour of the worksheet tab. A valid colour (belonging to colours()) or a valid hex colour beginning with "#"
`zoom` | A numeric between 10 and 400. Worksheet zoom level as a percentage.
`header` | document header. Character vector of length 3 corresponding to positions left, center, right. Use NA to skip a position.
`footer` | document footer. Character vector of length 3 corresponding to positions left, center, right. Use NA to skip a position.
`evenHeader` | document header for even pages.
`evenFooter` | document footer for even pages.
`firstHeader` | document header for first page only.
`firstFooter` | document footer for first page only.
`visible` | If FALSE, sheet is hidden else visible.
`paperSize` | An integer corresponding to a paper size. See ?pageSetup for details.
`orientation` | One of "portrait" or "landscape"
`vdpi` | Vertical DPI. Can be set with options("openxlsx.dpi" = X) or options("openxlsx.vdpi" = X)
`hdpi` | Horizontal DPI. Can be set with options("openxlsx.dpi" = X) or options("openxlsx.hdpi" = X)

### Details

Headers and footers can contain special tags

- &[Page] Page number

- &[Pages] Number of pages

- &[Date] Current date

- &[Time] Current time

- &[Path] File path

- &[File] File name

- &[Tab] Worksheet name

### Value

XML tree

### Author(s)

Alexander Walker

### Examples

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

    ## Add 3 worksheets
    addWorksheet(wb, "Sheet 1")
    addWorksheet(wb, "Sheet 2", gridLines = FALSE)
    addWorksheet(wb, "Sheet 3", tabColour = "red")
    addWorksheet(wb, "Sheet 4", gridLines = FALSE, tabColour = "#4F81BD")

    ## Headers and Footers
    addWorksheet(wb, "Sheet 5",
    header = c("ODD HEAD LEFT", "ODD HEAD CENTER", "ODD HEAD RIGHT"),
    footer = c("ODD FOOT RIGHT", "ODD FOOT CENTER", "ODD FOOT RIGHT"),
    evenHeader = c("EVEN HEAD LEFT", "EVEN HEAD CENTER", "EVEN HEAD RIGHT"),
    evenFooter = c("EVEN FOOT RIGHT", "EVEN FOOT CENTER", "EVEN FOOT RIGHT"),
    firstHeader = c("TOP", "OF FIRST", "PAGE"),
    firstFooter = c("BOTTOM", "OF FIRST", "PAGE"))

    addWorksheet(wb, "Sheet 6",
                 header = c("&[Date]", "ALL HEAD CENTER 2", "&[Page] / &[Pages]"),
                 footer = c("&[Path]&[File]", NA, "&[Tab]"),
                 firstHeader = c(NA, "Center Header of First Page", NA),
                 firstFooter = c(NA, "Center Footer of First Page", NA))

    addWorksheet(wb, "Sheet 7",
                 header = c("ALL HEAD LEFT 2", "ALL HEAD CENTER 2", "ALL HEAD RIGHT 2"),
                 footer = c("ALL FOOT RIGHT 2", "ALL FOOT CENTER 2", "ALL FOOT RIGHT 2"))

    addWorksheet(wb, "Sheet 8",
                 firstHeader = c("FIRST ONLY L", NA, "FIRST ONLY R"),
                 firstFooter = c("FIRST ONLY L", NA, "FIRST ONLY R"))

    ## Need data on worksheet to see all headers and footers
    writeData(wb, sheet = 5, 1:400)
    writeData(wb, sheet = 6, 1:400)
    writeData(wb, sheet = 7, 1:400)
    writeData(wb, sheet = 8, 1:400)

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

[Package openxlsx version 4.1.0 Index]