API for openxlsx2
Read, Write and Edit 'xlsx' Files

Global functions
%>% Man page
+.fmt_txt Man page
.onUnload Source code
[.wb_data Man page
`%out%` Source code
`%||%` Source code
`%|||%` Source code
active_sheet-wb Man page
amp_split Source code
apply_reg_match Source code
apply_reg_match0 Source code
as.character.fmt_txt Man page Source code
as_POSIXct_utc Source code
as_POSIXlt_hms Source code
as_binary Source code
as_fmt_txt Source code
as_xml Man page Source code
as_xml_attr Source code
assert_chart_sheet Source code
assert_class Source code
assert_color Source code
assert_comment Source code
assert_hyperlink Source code
assert_named_region Source code
assert_sheet_data Source code
assert_workbook Source code
assert_worksheet Source code
assert_xml_bool Source code
ave2 Source code
base_font-wb Man page
basename2 Source code
bottom_half Source code
cacheFields Source code
calc_col_width Source code
calc_distance Source code
carry_forward Source code
cf_begins_with Source code
cf_between Source code
cf_bottom_n Source code
cf_create_colorscale Source code
cf_create_contains_text Source code
cf_create_databar Source code
cf_create_duplicated_values Source code
cf_create_expression Source code
cf_create_not_contains_text Source code
cf_ends_with Source code
cf_icon_set Source code
cf_isblank Source code
cf_iserror Source code
cf_isnoblank Source code
cf_isnoerror Source code
cf_top_n Source code
cf_unique_values Source code
chart1_rels_xml Source code
check_wb_dims_args Source code
chooseExcelApp Source code
clean_worksheet_name Man page Source code
clone_shared_strings Source code
col2hex Source code
col2int Man page Source code
col_to_df Source code
col_to_int Source code
col_widths-wb Man page
comment_internal Man page
comments_bin Source code
con_dims Man page Source code
con_rng Man page Source code
conv_to_excel_date Source code
convertToExcelDate Man page Source code
convert_date Man page Source code
convert_datetime Man page Source code
convert_hms Man page Source code
convert_to_excel_date Man page Source code
copy Source code
create_border Man page Source code
create_cell_style Man page Source code
create_char_dataframe Source code
create_colors_xml Man page Source code
create_colours_xml Man page
create_comment Man page Source code
create_dxfs_style Man page Source code
create_fill Man page Source code
create_font Man page Source code
create_hyperlink Man page Source code
create_numfmt Man page Source code
create_pivot_table Source code
create_pivottablestyle Man page Source code
create_shape Man page Source code
create_sparklines Man page Source code
create_tablestyle Man page Source code
creators-wb Man page
current_sheet Man page Source code
dataframe_to_dims Man page Source code
default_save_opt Source code
delete_data Man page Source code
determine_select_valid Source code
df_to_xml Source code
dims_helper Man page
dims_to_dataframe Man page Source code
dims_to_df Source code
dims_to_rowcol Man page Source code
dir_create Source code
distinct Source code
do_remove_comment Source code
do_write_comment Source code
do_write_data Source code
do_write_datatable Source code
do_write_formula Source code
drawings Source code
drawings_rels Source code
empty_cols_attr Source code
empty_row_attr Source code
escape_forward_slashes Source code
escape_specials Source code
externalreferences_bin Source code
fetch_styles Source code
file_ext2 Source code
filename_id Source code
filter-wb Man page
find_a1_notation Source code
fits_in_dims Source code
fix_pt_names Source code
fmt_txt Man page Source code
fmt_txt2 Source code
formCntrlDrawing Source code
fullsided Source code
fun_tab_cols Source code
genBaseApp Source code
genBaseContent_Type Source code
genBasePic Source code
genBaseShapeVML Source code
genBaseSheetRels Source code
genBaseStyleSheet Source code
genBaseTheme Source code
genBaseWorkbook Source code
genBaseWorkbook.xml.rels Source code
genClientData Source code
genClientDataFC Source code
genHeaderFooterNode Source code
genSlicerCachesExtLst Source code
genTimelineCachesExtLst Source code
gen_databar_extlst Source code
getFile Source code
getHeaderFooterNode Source code
getXMLPtr1con Source code
getXMLXPtr0 Source code
getXMLXPtr1 Source code
getXMLXPtr1attr Source code
getXMLXPtr1val Source code
getXMLXPtr2 Source code
getXMLXPtr2attr Source code
getXMLXPtr2val Source code
getXMLXPtr3 Source code
getXMLXPtr3attr Source code
getXMLXPtr3val Source code
getXMLXPtrName1 Source code
getXMLXPtrName2 Source code
getXMLXPtrName3 Source code
get_cell_refs Source code
get_cell_styles Source code
get_cellstyle Source code
get_color Source code
get_colstyle Source code
get_date_origin Source code
get_dims Source code
get_items Source code
get_named_regions_tab Source code
get_next_id Source code
get_nr_from_definedName Source code
get_relship_id Source code
get_rowstyle Source code
grouping-wb Man page
guard_ws Source code
guess_col_type Source code
has_illegal_chars Source code
hashPassword Source code
headerFooterSub Source code
if_not_missing Source code
illegal_chars Source code
import_styles Source code
initialize_cell Source code
inner_update Source code
int2col Man page Source code
is_charnum Source code
is_dims Man page Source code
is_integer_ish Source code
is_na_strings Source code
is_single_cell Source code
is_to_txt Source code
is_waiver Source code
is_wbColour Source code
is_xml Source code
known_subtotal_funs Source code
last_table_id Source code
lcr Source code
legal_chars Source code
legal_sub Source code
loadvals Source code
long_to_wide Source code
match.arg_wrapper Source code
match_oneof Source code
min_and_max Source code
naToNULLList Source code
na_strings Man page Source code
named_region-wb Man page
needed_cells Source code
next_cell Source code
next_sheet Man page Source code
numfmt_is_date Source code
numfmt_is_hms Source code
numfmt_is_posix Source code
onesided Source code
openxlsx2 Man page
openxlsx2-deprecated Man page
openxlsx2-package Man page
openxlsx2_options Man page
openxlsx2_type Source code
ox_int_to_col Source code
parseOffset Source code
paste_c Source code
person-wb Man page
pivot_def_rel Source code
pivot_def_xml Source code
pivot_rec_xml Source code
pivot_xml_rels Source code
print.fmt_txt Man page Source code
print.pugi_xml Man page Source code
printXPtr Source code
properties-wb Man page
pugixml Man page
pxml Source code
random_string Source code
rbindlist Source code
readXML Source code
read_Content_Types Source code
read_border Source code
read_cellStyle Source code
read_colors Source code
read_dxf Source code
read_fill Source code
read_font Source code
read_numfmt Source code
read_sheetpr Source code
read_tableStyle Source code
read_workbook.xml.rels Source code
read_xf Source code
read_xlsx Man page Source code
read_xml Man page Source code
read_xml2df Source code
read_xml_files Source code
reg_match Source code
reg_match0 Source code
relship_no Source code
remove_comment Man page Source code
replaceXMLEntities Source code
replace_a1_notation Source code
replace_illegal_chars Source code
replace_legal_chars Source code
replace_waiver Source code
row_col_items Source code
row_heights-wb Man page
rowcol_to_dim Source code
rowcol_to_dims Man page Source code
set_border Source code
set_cellstyle Source code
set_cellstyles Source code
set_fill Source code
set_font Source code
set_numfmt Source code
set_sst Source code
shared_as_fml Source code
sharedstrings_bin Source code
sheet_names-wb Man page
sheet_visibility-wb Man page
si_to_txt Source code
solve_merge Source code
split_dim Source code
split_dims Source code
st_guid Source code
st_userid Source code
standardize Source code
standardize_case_names Source code
standardize_color_names Source code
style_is_date Source code
style_is_hms Source code
style_is_posix Source code
styles_bin Source code
styles_on_sheet Man page Source code
table_bin Source code
table_ids Source code
temp_dir Source code
temp_xlsx Man page Source code
to_long Source code
to_string Source code
top_half Source code
transpose_df Source code
twosided Source code
txt_to_is Source code
txt_to_si Source code
un_list Source code
unapply Source code
unkgetXMLXPtr3 Source code
update_cell Source code
validCol Source code
validRow Source code
validate_cf_params Source code
validate_color Source code
waivers Man page
wapply Source code
wbWorkbook Man page
wb_add_border Man page Source code
wb_add_cell_style Man page Source code
wb_add_chart_xml Man page Source code
wb_add_chartsheet Man page Source code
wb_add_comment Man page Source code
wb_add_conditional_formatting Man page Source code
wb_add_creators Man page Source code
wb_add_data Man page Source code
wb_add_data_table Man page Source code
wb_add_data_validation Man page Source code
wb_add_drawing Man page Source code
wb_add_dxfs_style Man page Source code
wb_add_fill Man page Source code
wb_add_filter Man page Source code
wb_add_font Man page Source code
wb_add_form_control Man page Source code
wb_add_formula Man page Source code
wb_add_hyperlink Man page Source code
wb_add_ignore_error Man page Source code
wb_add_image Man page Source code
wb_add_mips Man page Source code
wb_add_mschart Man page Source code
wb_add_named_region Man page Source code
wb_add_named_style Man page Source code
wb_add_numfmt Man page Source code
wb_add_page_break Man page Source code
wb_add_person Man page Source code
wb_add_pivot_table Man page Source code
wb_add_plot Man page Source code
wb_add_slicer Man page Source code
wb_add_sparklines Man page Source code
wb_add_style Man page Source code
wb_add_thread Man page Source code
wb_add_timeline Man page Source code
wb_add_worksheet Man page Source code
wb_base_colors Man page
wb_cell_style Man page
wb_check_overwrite_tables Source code
wb_clean_sheet Man page Source code
wb_clone_sheet_style Man page Source code
wb_clone_worksheet Man page Source code
wb_color Man page Source code
wb_colour Man page
wb_comment Man page Source code
wb_copy_cells Man page Source code
wb_create_columns Source code
wb_data Man page Source code
wb_dims Man page Source code
wb_freeze_pane Man page Source code
wb_get_active_sheet Man page Source code
wb_get_base_colors Man page Source code
wb_get_base_colours Man page
wb_get_base_font Man page Source code
wb_get_bookview Man page Source code
wb_get_cell_style Man page Source code
wb_get_comment Man page Source code
wb_get_creators Man page Source code
wb_get_mips Man page Source code
wb_get_named_regions Man page Source code
wb_get_order Man page Source code
wb_get_person Man page Source code
wb_get_properties Man page Source code
wb_get_selected Man page Source code
wb_get_sheet_names Man page Source code
wb_get_sheet_visibility Man page Source code
wb_get_tables Man page Source code
wb_get_thread Man page Source code
wb_grid_lines Man page Source code
wb_group_cols Man page Source code
wb_group_rows Man page Source code
wb_hyperlink Source code
wb_load Man page Source code
wb_merge_cells Man page Source code
wb_open Man page Source code
wb_order Man page
wb_page_setup Man page Source code
wb_protect Man page Source code
wb_protect_worksheet Man page Source code
wb_read Man page Source code
wb_remove_bookview Man page Source code
wb_remove_col_widths Man page Source code
wb_remove_comment Man page Source code
wb_remove_conditional_formatting Man page Source code
wb_remove_creators Man page Source code
wb_remove_filter Man page Source code
wb_remove_hyperlink Man page Source code
wb_remove_named_region Man page Source code
wb_remove_row_heights Man page Source code
wb_remove_slicer Man page Source code
wb_remove_tables Man page Source code
wb_remove_timeline Man page Source code
wb_remove_worksheet Man page Source code
wb_save Man page Source code
wb_set_active_sheet Man page Source code
wb_set_base_colors Man page Source code
wb_set_base_colours Man page
wb_set_base_font Man page Source code
wb_set_bookview Man page Source code
wb_set_cell_style Man page Source code
wb_set_cell_style_across Man page Source code
wb_set_col_widths Man page Source code
wb_set_creators Man page Source code
wb_set_grid_lines Man page Source code
wb_set_header_footer Man page Source code
wb_set_last_modified_by Man page Source code
wb_set_order Man page Source code
wb_set_properties Man page Source code
wb_set_row_heights Man page Source code
wb_set_selected Man page Source code
wb_set_sheet_names Man page Source code
wb_set_sheet_visibility Man page Source code
wb_set_sheetview Man page Source code
wb_sheet_data Source code
wb_to_df Man page Source code
wb_to_hyperlink Source code
wb_ungroup_cols Man page Source code
wb_ungroup_rows Man page Source code
wb_unmerge_cells Man page Source code
wb_upd_custom_pid Source code
wb_update_table Man page Source code
wb_validate_sheet Source code
wb_validate_table_name Source code
wb_workbook Man page Source code
wb_worksheet Source code
wide_to_long Source code
workbook_bin Source code
worksheet_bin Source code
worksheet_lock_properties Source code
write_Content_Types Source code
write_border Source code
write_cellStyle Source code
write_colors Source code
write_comment Man page Source code
write_comment_xml Source code
write_data Man page Source code
write_data2 Source code
write_data_table Source code
write_datatable Man page Source code
write_df2xml Source code
write_dxf Source code
write_file Source code
write_fill Source code
write_font Source code
write_formula Man page Source code
write_numfmt Source code
write_sheetpr Source code
write_tableStyle Source code
write_workbook.xml.rels Source code
write_worksheet Source code
write_worksheet_slim Source code
write_xf Source code
write_xlsx Man page Source code
write_xmlPtr Source code
write_xml_file Source code
xl_open Man page Source code
xl_open.default Man page Source code
xl_open.wbWorkbook Man page Source code
xml_add_child Man page Source code
xml_append_child1 Source code
xml_append_child2 Source code
xml_append_child3 Source code
xml_attr Man page Source code
xml_attr_mod Man page Source code
xml_node Man page Source code
xml_node_create Man page Source code
xml_node_name Man page Source code
xml_remove_child1 Source code
xml_remove_child2 Source code
xml_remove_child3 Source code
xml_rm_child Man page Source code
xml_si_to_txt Source code
xml_value Man page Source code
openxlsx2 documentation built on April 3, 2025, 8:40 p.m.