crosstable_options {crosstable} | R Documentation |
Options for the package crosstable
Description
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.
Usage
crosstable_options(
...,
zero_percent = FALSE,
only_round = FALSE,
verbosity_autotesting = "default",
verbosity_duplicate_cols = "default",
crosstable_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_arg,
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,
units = "in",
peek_docx = TRUE,
font_code = "Consolas",
add_max_cols = 25,
format_legend_name,
table_legend_par_before,
table_legend_prefix,
figure_legend_par_after,
figure_legend_prefix,
normal_squish,
title_squish,
allow_break,
style_normal,
style_character,
style_strong,
style_image,
style_legend,
style_heading,
style_list_ordered,
style_list_unordered,
scientific_log,
.local = FALSE,
reset = deprecated()
)
Arguments
... |
unused |
zero_percent |
set to TRUE so that proportions are not displayed if |
only_round |
default argument for |
verbosity_autotesting |
one of |
verbosity_duplicate_cols |
one of |
crosstable_fishertest_B |
number of simulations to perform when |
total |
For setting |
percent_pattern |
For setting |
margin |
For setting |
percent_digits |
For setting |
num_digits |
For setting |
showNA |
For setting |
label |
For setting |
funs |
For setting |
funs_arg |
For setting |
cor_method |
For setting |
drop_levels |
For setting |
unique_numeric |
For setting |
date_format |
For setting |
times |
For setting |
followup |
For setting |
test_arg |
For setting |
effect_args |
For setting |
wrap_id |
if |
compact_padding |
in flextables, left-padding for non-headers rows when |
header_show_n_pattern |
glue pattern used when showing N in the header of flextables. |
keep_id |
For setting |
by_header |
For setting |
autofit |
For setting |
compact |
For setting |
remove_header_keys |
For setting |
show_test_name |
For setting |
padding_v |
For setting |
header_show_n |
For setting |
fontsize_body |
For setting |
fontsize_subheaders |
For setting |
fontsize_header |
For setting |
units |
default units in |
peek_docx |
behavior of |
font_code |
font family used to show code, most likely a monospaced typeface such as Consolas (default) |
add_max_cols |
max number of columns a crosstable can have to be added to a Word document |
format_legend_name |
how the legend name ("Table", "Figure") is formatted. Default to |
table_legend_par_before |
whether to add an empty paragraph before all table legends |
table_legend_prefix , figure_legend_prefix |
a prefix before each legend, after the numbering |
figure_legend_par_after |
whether to add an empty paragraph after all figure legends |
normal_squish |
Should you squish text in normal paragraphs? |
title_squish |
Should you squish text in headers paragraphs? |
allow_break |
allow crosstable rows to break across pages |
style_normal |
For specifying styles used in your |
style_character |
For specifying styles used in your |
style_strong |
For specifying styles used in your |
style_image |
For specifying styles used in your |
style_legend |
For specifying styles used in your |
style_heading |
For specifying styles used by headings on different levels. Levels will be pasted in the end (e.g. use |
style_list_ordered , style_list_unordered |
For specifying styles used by lists in the |
scientific_log |
the maximum power a number can have before being formatted as scientific. Default to 4 so applies on numbers <1e-4 or >1e4. |
.local |
if TRUE, the effect will only apply to the local frame (thanks to |
reset |
if |
Value
Nothing, called for its side effects
See Also
crosstable_peek_options()
and crosstable_reset_options()