Skip to contents

Use this function to manage your crosstable parameters globally while taking advantage of autocompletion. Use crosstable_peek_options() to see which option is currently set.

Usage

crosstable_options(
  reset = FALSE,
  crosstable_zero_percent,
  crosstable_verbosity_autotesting,
  crosstable_verbosity_duplicate_cols,
  crosstable_wrap_id,
  crosstable_only_round,
  crosstable_units,
  crosstable_peek_docx,
  crosstable_compact_padding,
  crosstable_font_code,
  crosstable_format_legend_name,
  crosstable_table_legend_par_before,
  crosstable_table_legend_prefix,
  crosstable_figure_legend_par_after,
  crosstable_figure_legend_prefix,
  crosstable_header_show_n_pattern,
  crosstable_total,
  crosstable_percent_pattern,
  crosstable_percent_digits,
  crosstable_num_digits,
  crosstable_showNA,
  crosstable_label,
  crosstable_funs,
  crosstable_funs_arg,
  crosstable_cor_method,
  crosstable_unique_numeric,
  crosstable_date_format,
  crosstable_times,
  crosstable_followup,
  crosstable_test_arg,
  crosstable_effect_args,
  crosstable_keep_id,
  crosstable_autofit,
  crosstable_compact,
  crosstable_remove_header_keys,
  crosstable_show_test_name,
  crosstable_padding_v,
  crosstable_header_show_n,
  crosstable_fontsize_body,
  crosstable_fontsize_header,
  crosstable_fontsize_subheaders,
  crosstable_normal_squish,
  crosstable_title_squish,
  crosstable_style_normal,
  crosstable_style_character,
  crosstable_style_strong,
  crosstable_style_image,
  crosstable_style_legend,
  crosstable_style_heading,
  crosstable_style_list_ordered,
  crosstable_style_list_unordered
)

Arguments

reset

if TRUE, set all these options back to default

crosstable_zero_percent

set to TRUE so that proportions are not displayed if n==0

crosstable_verbosity_autotesting

one of default, quiet, or verbose

crosstable_verbosity_duplicate_cols

one of default, quiet, or verbose.

crosstable_wrap_id

if id contains no spaces, wrap it with this maximum number of characters.

crosstable_only_round

default argument for format_fixed()

crosstable_units

default units in body_add_gg2() and body_add_img2()

crosstable_peek_docx

behavior of peek(), which will open a docx if TRUE (default) and an xlsx if FALSE

crosstable_compact_padding

in flextables, left-padding for non-headers rows when compact=TRUE.

crosstable_font_code

font family used to show code, most likely a monospaced typeface such as Consolas (default)

crosstable_format_legend_name

how the legend name ("Table", "Figure") is formatted. Default to officer::fp_text_lite(bold=TRUE)

crosstable_table_legend_par_before

whether to add an empty paragraph before all table legends

crosstable_table_legend_prefix, crosstable_figure_legend_prefix

a prefix before each legend, after the numbering

crosstable_figure_legend_par_after

whether to add an empty paragraph after all figure legends

crosstable_header_show_n_pattern

glue pattern used when showing N in the header of flextables. .col is the name of the column and .n the size of the group. Default to {.col} (N={.n}).

crosstable_total

For setting crosstable() arguments globally.

crosstable_percent_pattern

For setting crosstable() arguments globally.

crosstable_percent_digits

For setting crosstable() arguments globally.

crosstable_num_digits

For setting crosstable() arguments globally.

crosstable_showNA

For setting crosstable() arguments globally.

crosstable_label

For setting crosstable() arguments globally.

crosstable_funs

For setting crosstable() arguments globally.

crosstable_funs_arg

For setting crosstable() arguments globally.

crosstable_cor_method

For setting crosstable() arguments globally.

crosstable_unique_numeric

For setting crosstable() arguments globally.

crosstable_date_format

For setting crosstable() arguments globally.

crosstable_times

For setting crosstable() arguments globally.

crosstable_followup

For setting crosstable() arguments globally.

crosstable_test_arg

For setting crosstable() arguments globally.

crosstable_effect_args

For setting crosstable() arguments globally.

crosstable_keep_id

For setting as_flextable() arguments globally.

crosstable_autofit

For setting as_flextable() arguments globally.

crosstable_compact

For setting as_flextable() arguments globally.

crosstable_remove_header_keys

For setting as_flextable() arguments globally.

crosstable_show_test_name

For setting as_flextable() arguments globally.

crosstable_padding_v

For setting as_flextable() arguments globally.

crosstable_header_show_n

For setting as_flextable() arguments globally.

crosstable_fontsize_body

For setting as_flextable() arguments globally.

crosstable_fontsize_header

For setting as_flextable() arguments globally.

crosstable_fontsize_subheaders

For setting as_flextable() arguments globally. Subheaders are only considered when compact=TRUE.

crosstable_normal_squish

Should you squish text in normal paragraphs?

crosstable_title_squish

Should you squish text in headers paragraphs?

crosstable_style_normal

For specifying styles used in your officer template.

crosstable_style_character

For specifying styles used in your officer template.

crosstable_style_strong

For specifying styles used in your officer template.

crosstable_style_image

For specifying styles used in your officer template.

crosstable_style_legend

For specifying styles used in your officer template.

crosstable_style_heading

For specifying styles used by headings on different levels. Levels will be pasted in the end (e.g. use "title" if your level 2 heading style is "title2").

crosstable_style_list_ordered, crosstable_style_list_unordered

For specifying styles used by lists in the rdocx template. Needed for body_add_list() to work.

Value

Nothing, called for its side effects