crosstable
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 and crosstable_reset_options()
to set all options back to default.
crosstable_options(
...,
remove_zero_percent = FALSE,
only_round = FALSE,
verbosity_autotesting = "default",
verbosity_duplicate_cols = "default",
fishertest_B = 1e+05,
total,
percent_pattern,
margin,
percent_digits,
num_digits,
showNA,
label,
funs,
funs_arg,
cor_method,
drop_levels,
unique_numeric,
date_format,
times,
followup,
test_args,
effect_args,
wrap_id = 70,
compact_padding = 25,
header_show_n_pattern = "{.col} (N={.n})",
keep_id,
by_header,
autofit,
compact,
remove_header_keys,
show_test_name,
padding_v,
header_show_n,
fontsize_body,
fontsize_subheaders,
fontsize_header,
generic_labels,
units = "in",
peek_docx = TRUE,
font_code = "Consolas",
add_max_cols = 25,
gg_width,
gg_height,
format_legend_name,
table_legend_par_before,
table_legend_prefix,
figure_legend_par_after,
figure_legend_prefix,
normal_squish,
normal_font_size,
title_squish,
allow_break,
section_title,
section_title_level,
section_sentence,
style_normal,
style_image,
style_legend,
style_heading,
style_list_ordered,
style_list_unordered,
scientific_log,
clean_names_fun,
verbosity_na_cols,
format_epsilon,
.local = FALSE,
reset = deprecated()
)
Nothing, called for its side effects
unused
set to TRUE so that proportions are not displayed if n==0
default argument for format_fixed()
one of default
, quiet
, or verbose
one of default
, quiet
, or verbose
.
number of simulations to perform when fisher.test()
is failing (FEXACT error 7).
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
For setting crosstable()
arguments globally.
if id
contains no spaces, wrap it with this maximum number of characters.
in flextables, left-padding for non-headers rows when compact=TRUE
.
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})
.
For setting as_flextable()
arguments globally.
For setting as_flextable()
arguments globally.
For setting as_flextable()
arguments globally.
For setting as_flextable()
arguments globally.
For setting as_flextable()
arguments globally.
For setting as_flextable()
arguments globally.
For setting as_flextable()
arguments globally.
For setting as_flextable()
arguments globally.
For setting as_flextable()
arguments globally.
For setting as_flextable()
arguments globally. Subheaders are only considered when compact=TRUE
.
For setting as_flextable()
arguments globally.
For setting as_flextable()
arguments globally.
default units in body_add_gg2()
and body_add_img2()
behavior of peek()
, which will open a docx
if TRUE
(default) and an xlsx
if FALSE
font family used to show code, most likely a monospaced typeface such as Consolas (default)
max number of columns a crosstable can have to be added to a Word document
cf. body_add_gg2()
how the legend name ("Table", "Figure") is formatted. Default to officer::fp_text_lite(bold=TRUE)
whether to add an empty paragraph before all table legends
a prefix before each legend, after the numbering
whether to add an empty paragraph after all figure legends
Should you squish text in normal paragraphs?
Font size in normal paragraph, cf. body_add_normal()
Should you squish text in headers paragraphs?
allow crosstable rows to break across pages
cf. body_add_table_section()
For specifying styles used in your {officer}
template.
For specifying styles used in your {officer}
template.
For specifying styles used in your {officer}
template.
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"
).
For specifying styles used by lists in the rdocx
template. Needed for body_add_list()
to work.
the maximum power a number can have before being formatted as scientific. Default to 4 so applies on numbers <1e-4 or >1e4.
cf. clean_names_with_labels()
verbosity of a warning
cf. format_fixed()
if TRUE, the effect will only apply to the local frame (thanks to rlang::local_options()
)
if TRUE
, set all these options back to default
crosstable_peek_options()
and crosstable_reset_options()