get_header_groups: Get column groups

Description Usage Arguments Details

View source: R/get_header_groups.R

Description

Beheads multiple headers defined according to expressions in .groupings.

Usage

1
2
3
4
5
get_header_groups(sheet, direction, value_ref, formats,
  .groupings = groupings(ones), .hook_if = hook_if(ones),
  .hook_if_rev = hook_if(ones), header_fill = "local_format_id",
  default_col_header_direction = default_col_header_direction_temp,
  table_data = tabledata, min_header_index = min_header_index_temp)

Arguments

sheet

data frame created by xlsx_cells

direction

a string indicating which type of headers are to be labelled. Options include compass direction or up/down/left/right.

value_ref

reference to where data cells are located.

formats

format object created by tidyxl.

.groupings

expressions representing how header cells are differentiated. Most naturally works with fmt_* functions.

.hook_if

expression determining whether direction is hooked.

.hook_if_rev

expression determining whether direction is reverse hooked.

header_fill

deals with merged cells. Fills in neighbouring cells if they have the same "local_format_id", "style" or are within "borders".

default_col_header_direction

Indicates which direction is given to col headers by default. Only need if "NNW" is required, rather than "N".

table_data

datacell dataframe.

min_header_index

min header index

Details

This is an internal function that: 1. Identifies which cells are likely to be headers 2. groups them according to their indenting, bold and italic formatting 3. Specifies the locatr function specifying the direction of the header w.r.t. table data Behead multiple header groups


ianmoran11/locatr documentation built on June 14, 2020, 3:32 a.m.