Report: Spreadsheet report

In tiagotaveiragomes/rigma.sheet: Sane Spreadsheet Development

Description

Spreadsheet report

Spreadsheet report

Public fields

wb

openxlsx.Workbook object

path

the directory where the report is to be generated

gdrive

the directory where the report is to be generated

name

the name of the report file

title

Human friendly version of the report name

author

Author that wrote the report

sheets

List that hols sheets object that show in the report

ts

Timestamp when the report was created

description

Description of the contents of the report

config.filename.ts

Whether to add the timestamp to the report file name

Active bindings

ts

Timestamp when the report was created

Methods

Public methods

• Report$new()

• Report$sheet.add()

• Report$save()

• Report$sheet.pane.freeze()

• Report$sheet.col.width()

• Report$sheet.add.style()

• Report$sheet.merge.header()

• Report$sheet.conditional.formatting()

• Report$clone()

---

Method new()

Initialize the report

Usage

Report$new(
  name,
  path,
  gdrive = NULL,
  title,
  description,
  author,
  config.filename.ts = TRUE
)

---

Method sheet.add()

Add a sheet object to the report

Usage

Report$sheet.add(sheet)

---

Method save()

Save the report to disk

Usage

Report$save()

---

Method sheet.pane.freeze()

Usage

Report$sheet.pane.freeze(name, row, col)

---

Method sheet.col.width()

Usage

Report$sheet.col.width(name, cols, width)

---

Method sheet.add.style()

Usage

Report$sheet.add.style(name, style, rows, cols, expand, stack)

---

Method sheet.merge.header()

Usage

Report$sheet.merge.header(name, col, row)

---

Method sheet.conditional.formatting()

Usage

Report$sheet.conditional.formatting(name, rows, cols, rule, style)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Report$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

tiagotaveiragomes/rigma.sheet documentation built on Aug. 9, 2020, 12:35 a.m.