add_body |
Add a table body (a df) to the tab. |
add_footer |
Add footers to the tab. Footer text is provided as a character vector, with each element being a row of the footer |
add_title |
Add titles to the tab. Title text is provided as a character vector, with each element being a row of the title |
add_top_headers |
Add top headers to the tab. The top headers are provided as a character vector. If you need more than one row, provide a list of character vectors. Top headers are automatically assigned the style_text 'top_header_1', but you may provide style overrides using column_style_names and row_style_names |
auto_crosstab_to_tab |
Take a cross tabulation produced by 'reshape2::dcast' and output a formatted openxlsx wb object |
auto_crosstab_to_wb |
Take a cross tabulation produced by 'reshape2::dcast' and output a formatted openxlsx wb object |
auto_detect_body_title_level |
Autodetect the 'title level' of each row in the cross tabulation e.g. title 1 is most prominent, title 2 next etc. |
auto_detect_left_headers |
Uses the presence of '(all)' in the leftmost columns of data to detect that these columns are really left headers rather than body columns |
auto_df_to_wb |
Take a data.frame in r and output an openxlsx wb object |
auto_merge_footer_cells |
Take a tab and merge the footer rows |
auto_merge_title_cells |
Take a tab and merge the title rows |
auto_style_indent |
Consolidate the header columns into one, taking the rightmost value and applying indent |
auto_style_number_formatting |
Use the data type of the columns to choose an automatic Excel format for body cells |
body_get_bottom_wb_row |
Compute the bottom (lowest) row of the workbook occupied by the body If the body does not exist, returns the last row of the previous element (the top header) |
body_get_cell_styles_table |
Create table with columns |row|col|style name| containing the styles names for each cell of the body |
body_get_rightmost_wb_col |
Compute the rightmost column of the workbook which is occupied by the body |
body_get_wb_cols |
Compute the columns of the workbook which are occupied by the body |
body_get_wb_left_header_cols |
Compute the columns of the workbook which are occupied by the left header columns (which are a subset of the body columns) |
body_get_wb_rows |
Compute the rows of the workbook which are occupied by the body |
body_initialise |
Initialise the body element of the tab, creating all the required properties the core tab object |
body_write_rows |
Write all the body data to the workbook (but do not write style information) |
get_cell_format_path |
Get cell formats path |
get_num_format_path |
Get number formats path |
get_style_path |
Get style sheet path |
initialise |
Create a new xltabr object for cross tabulation |
set_cell_format_path |
Set cell format path |
set_num_format_path |
Set number format path |
set_style_path |
Set style sheet path |
set_wb_widths |
Set column widths to tab workbook |
style_catalogue_add_excel_num_format |
Manually add an Excel num format to the style catalogue |
style_catalogue_add_openxlsx_style |
Manually add an openxlsx s4 style the style catalogue |
title_get_bottom_wb_row |
Get the bottom row which the titles occupy in the workbook If no titles have been provided, return the cell above the topleft row of the extent. The next element (top headers, body or whatever it is) will want to be positioned in the cell below this |
title_get_cell_styles_table |
Create table with columns |row|col|style name| that contains the styles names |
title_get_rightmost_wb_col |
Get the rightmost column occupied by the titles in the workbook |
title_get_wb_cols |
Get the columns occupied by the title in the workbook |
title_get_wb_rows |
Get the rows occupied by the title in the workbook |
title_initialise |
Create all the required properties for the title on the tab object |
title_write_rows |
Write all the title data to the workbook (but do not write style data) |
top_headers_get_bottom_wb_row |
Compute the bottom (lowest) row of the workbook occupied by the top headers If the top headers do not exist, returns the last row of the previous element (the titles) |
top_headers_get_cell_styles_table |
Create table with columns |row|col|style name| containing the styles names for each cell of the top headers |
top_headers_get_rightmost_wb_col |
Compute the rightmost column of the workbook which is occupied by the top headers |
top_headers_get_wb_cols |
Compute the columns of the workbook which are occupied by the top headers |
top_headers_get_wb_rows |
Compute the rows of the workbook which are occupied by the top headers |
top_headers_initialise |
Create all the required properties for the top headers on the tab object |
top_headers_write_rows |
Write all the top header data to the workbook (but do not write style information) |
write_data_and_styles_to_wb |
Write the styles and data contained in tab object to the workbook at tab$wb. This is useful if the user has prepared a tab object, e.g. using auto_crosstab_to_tab maybe performed some customisation, and now needs to write out to the workbook |