xlsx.addHeader: Add a header to a worksheet

In kassambara/r2excel: Read, write and format Excel files in R

Description

Add a header (title and sub-title) to an Excel worksheet.

Usage

xlsx.addHeader(wb, sheet, value = "Header", level = 1, 
              color = "#FFFFFF", startRow = NULL,
              startCol = 2, underline = c(0, 1, 2))

Arguments

wb	workbook object
sheet	sheet object
value	the text to write as a header
level	header level; possible values are form 1 to 6
color	the color to use for the header
startRow	a numeric value specifying the starting row
startCol	a numeric value specifying the starting column
underline	a numeric value specifying whether the header should be underlined or not. Possible values are 0 (default value, no underline), 1 (underline with one line), 2 (underline with two lines)

Author(s)

Alboukadel Kassambara <[e-mail]>

References

http://www.sthda.com

Examples

# create an Excel workbook. Both .xls and .xlsx file formats can be used.
wb <- createWorkbook(type="xlsx")
# Create a sheet in that workbook
sheet <- xlsx::createSheet(wb, sheetName = "example1")
 
# header level 1
xlsx.addHeader(wb, sheet, value="Header 1",level=1, color="black")
# header level 2
xlsx.addHeader(wb, sheet, value="Header 2",level=2, color="black")
# header level 3
xlsx.addHeader(wb, sheet, value="Header 3",level=3, color="black")
# header level 4
xlsx.addHeader(wb, sheet, value="Header 4",level=4, color="black")
# header level 5
xlsx.addHeader(wb, sheet, value="Header 5",level=5, color="black")
# header level 6
xlsx.addHeader(wb, sheet, value="Header 6",level=6, color="black")

# Underline the header
xlsx.addHeader(wb, sheet, value="Header 1",level=1, color="blue", underline=1)
xlsx.addHeader(wb, sheet, value="Header 1",level=1, color="blue", underline=2)

# saving a workbook to an Excel file and write the file to the disk.
saveWorkbook(wb, "examples_add_header.xlsx")

kassambara/r2excel documentation built on May 20, 2019, 7:40 a.m.