writeData_gridVertical: Write List of Data Frames to a Vertically Stacked Grid

View source: R/xl-write.R

writeData_gridVerticalR Documentation

Write List of Data Frames to a Vertically Stacked Grid

Description

Write a list of Data Frames to worksheet with vertically stacked layout with optional styling. A wrapper around openxlsx::writeData()

Usage

writeData_gridVertical(
  wb,
  sheet,
  ls_df,
  startCol = 1,
  startRow = 1,
  gapRow = 1,
  headerStyle = NULL,
  borders = "columns",
  ...
)

Arguments

wb

A Workbook object containing a worksheet.

sheet

The worksheet to write to. Can be the worksheet index or name.

ls_df

A list of data frame

startCol

(Numeric vector of length 1) specifying the starting column to write to.

startRow

(Numeric vector of length 1) specifying the starting row of the first data frame to write to.

gapRow

(Numeric vector of length 1) specifying number of empty rows (gaps) between each data frame

headerStyle

Custom style to apply to column names. If NULL, generate style automatically. Can input as openxlsx::createStyle() objects.

borders

Either "none" (default), "surrounding", "columns", "rows" or respective abbreviations. If "surrounding", a border is drawn around the data. If "rows", a surrounding border is drawn with a border around each row. If "columns", a surrounding border is drawn with a border between each column. If "all" all cell borders are drawn.

...

passed to openxlsx::writeData()

Value

the same as openxlsx::writeData()

Examples

NULL

Lightbridge-KS/lbdoc documentation built on May 16, 2024, 3:03 p.m.