_pkgdown.yml

url: https://janmarvin.github.io/openxlsx2

destination: docs

home:
  links:
  - text: Learn more
    href: https://janmarvin.github.io/ox2-book/

template:
  bootstrap: 5
  light-switch: true

development:
  mode: auto

reference:
- title: Read tabular data
  desc: >
    Read data out of an xlsx file as an R object
  contents:
  - wb_to_df

- title: Write tabular data
  desc: >
    Write tabular data frame(s) to file with options
  contents:
  - write_xlsx

- title: Load a workbook
  desc: >
     Load and interact with an existing workbook
  contents:
  - wb_load
  - wbWorkbook

- title: Create a workbook
  desc: >
    Add content to a help you interact to a new or existing workbook.
  contents:
  - wb_workbook

- title: Add content to a workbook
  desc: >
    Add data or images to a new or existing workbook
- subtitle: Add a sheet to a workbook
  contents:
  - wb_add_worksheet

- subtitle: Add to a worksheet
  desc: >
    These functions help you write in worksheets. They invisibly return the
    `wbWorkbook` object, except for `get_` functions, who return a character vector,
    unless specified otherwise.
  contents:
  - has_concept("worksheet content functions")

- subtitle: Add images and charts to a worksheet
  desc: >
    Add images or Excel charts to a worksheet with the mschart package.
    See `vignette("openxlsx2_charts_manual")`.
  contents:
  - wb_add_image
  - wb_add_plot
  - wb_add_chartsheet
  - wb_add_mschart

- title: Style a workbook
  desc: >
    Style a cell region, a worksheet or the entire workbook.
    See `vignette("openxlsx2_style_manual")`.

- subtitle: Worksheet styling
  desc: >
    Add styling to a cell region in a worksheet
  contents:
  - has_concept("styles")

- subtitle: Workbook styling
  desc: >
    These styling functions apply formatting to the workbook globally.
  contents:
  - has_concept("workbook styling functions")

- title: View and save a workbook
  desc: >
    Visualize the content of a workbook in a spreadsheet software and save it
  contents:
  - wb_open
  - wb_save
  - xl_open

- title: Edit workbook defaults
  desc: >
    These functions are used to modify setting of a workbook as a whole.
  contents:
  - properties-wb
  - wb_set_last_modified_by
  - creators-wb
  - wb_order
  - sheet_names-wb
  - wb_remove_worksheet
  - active_sheet-wb
  - sheet_visibility-wb
  - wb_set_bookview
  - person-wb
  - wb_protect
  - wb_get_tables
  - wb_remove_tables

- title: Workbook editing helpers
  desc: >
    These functions are helpers that create an intermediate object.
    They are helpful with editing a workbook. They are useful when you add content,
    styling or you want to modify certain elements.
  contents:
  - wb_color
  - wb_comment
  - wb_data
  - wb_dims
  - starts_with("create_")


- title: Other functions
  desc: >
    These functions can be used to achieve more specialized operations.

- subtitle: Other tools to interact with worksheets
  contents:
  - wb_add_comment
  - wb_add_sparklines
  - wb_add_chart_xml
  - wb_add_drawing
  - wb_add_data_validation
  - wb_add_form_control
  - wb_add_ignore_error
  - wb_add_page_break
  - wb_add_mips
  - wb_clean_sheet
  - starts_with("wb_clone")
  - starts_with("wb_copy")
  - wb_page_setup
  - wb_protect_worksheet
  - wb_set_grid_lines
  - wb_set_header_footer
  - wb_set_sheetview
  - wb_update_table


- subtitle: XML functions
  desc: >
    A curated list of XML functions used in openxlsx2.
  contents:
  - read_xml
  - starts_with("xml_")
  - as_xml
  - starts_with("print.pugi")

- subtitle: Other helpers
  contents:
  - int2col
  - col2int
  - fmt_txt
  - starts_with("convert_")
  - temp_xlsx
  - waivers
  - dims_helper
  - clean_worksheet_name
  - styles_on_sheet

- title: Package introduction
  contents:
  - openxlsx2-package

- title: Package options
  contents:
  - openxlsx2_options

- title: Deprecated
  contents:
  - openxlsx2-deprecated

redirects:
  - ["articles/openxlsx2_basic_manual.html", "articles/openxlsx2.html"]