Function reference • saros

Main use

The only functions you will probably use

draft_report(): Automatically Draft a Quarto Report

Example data and metadata

You would need to create these two types of data frames.

ex_survey1: ex_survey1: Mockup dataset of a survey.

ex_survey_ch_overview: ex_survey_ch_overview: Mock overview of chapter structure

Handling the overwhelming amount of settings for non-R users

By using YAML, settings can be stored in a file that is human-readable and machine-readable. These functions allow easy reading and writing such files and using these in draft_report()

write_default_draft_report_args(): Write Default Arguments for draft_report() to YAML-file

read_default_draft_report_args(): Read Default Arguments for draft_report() from YAML-file

Access to draft_report() options

Allows quick reference of possible options for certain arguments in draft_report()

get_data_label_opts(): Get Valid Data Labels for Figures and Tables

list_available_element_types(): List All Valid Names of The Elements Argument

Useful data preparation tools

These functions will hopefully be moved to another package

refine_chapter_overview(): Processes A 'chapter_overview' Data Frame

col_to_binaries(): Mutate a (factor, character, integer, etc) column into multiple columns,

swap_label_colnames() swap_label_colnames(): Swap Dataset Columns and Labels

replace_stata_labels(): Replace Stata Labels

rename_by_labels() rename_by_labels(): Rename Dataset Columns by Labels.

remove_special_chars_in_labels(): Remove Special Characters (<,>) in Variable Labels

handpick(): Return character vector of manually picked data columns.

omitted_recoder_df(): Recode Missing By Type of Missingness

subset_vector(): Given Ordered Integer Vector, Return Requested Set.

center_string(): Center String Vector

combn_upto(): Create All Possible Combinations of Vector Elements with Minimum A and Maximum B.

create_caption(): Adds caption attribute

get_colour_set(): Provide A Colour Set for A Number of Requested Colours

hex_bw(): Identify Suitable Font Given Background Hex Colour

is_colour(): Are All Colours in Vector Valid Colours

Useful website management tools

create_htaccess(): Create Bulk of .htaccess files in local folders, having valid AuthUserFile when uploaded to ftp-server at remote_basepath

upload_to_ftp(): Easily upload folder to ftp-server, with safe storage of credentials

Create individual elements (usually called automatically)

embed_bi_sigtest(): Bivariate significance tests

embed_cat_freq_plot(): Embed Interactive Categorical Plot

embed_cat_freq_plot_docx(): Create Word Report with Univariates for Categorical Columns Sharing Same Categories

embed_cat_prop_plot(): Embed Interactive Categorical Plot

embed_cat_prop_plot_docx(): Create Word Report with Univariates for Categorical Columns Sharing Same Categories

embed_cat_table(): Embed Reactable Table

embed_cat_text_html(): Creates a structured list with text interpretations for a set of variables.

embed_chr_table_html(): Interactive table of text data

embed_uni_sigtest(): Title

sigtest(): Test Significance Based on Randomization Theory

summarize_data(): Summarize a survey dataset for use in tables and graphs

Internal functions

stopwords: Stopwords