Package index • saros.base

Preparing data

check_variable_labels(): Check Variable Labels for Saros Use

sanitize_chr_vec(): Sanitize character vector, for instance useful for variable label in labelled::update_variable_labels_with()

Used to create the structure of your report(s)

refine_chapter_overview(): Processes A 'chapter_overview' Data Frame

Main use

The only functions you will probably use, in the order listed

draft_report(): Automatically Draft a Quarto Report

setup_mesos(): Simply create qmd-files and yml-files for mesos reports

setup_mesos_structure(): Create directory structure for mesos reports (improved version)

Post-processing tools (possibly movin to a Quarto extension at a later stage)

remove_entry_from_sidebar(): Removes entries in sidebar if containing a filename regex pattern.

Auxiliary functions to obtain defaults

get_chunk_template_defaults(): Get Global Options for Chunk Templates

get_organize_by_opts(): Get Core Chapter Structure Column Names

Example data and metadata

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

ex_survey: ex_survey: Mockup dataset of a survey.

ex_survey_ch_overview: ex_survey_ch_overview: Mock overview of chapter structure

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

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

Website management tools

Share reports to various recipients with password access and automatic sending of emails

setup_access_restrictions(): Setup files needed for basic password-based access restriction for website

create_email_credentials(): Create Data Frame Containing Email Drafts with User Credentials

detect_malformed_quarto_project(): Detect malformed Quarto website projects generated by saros.base

Project startup tools - main wrapper functions

For project templates (might be dropped in favour of 3rd party packages focusing on this)

initialize_saros_project(): Initialize Folder Structure

download_zip_to_folder(): Wrapper to Download and Unzip a Github Repository to A Folder

Project startup tools - underlying functions

For project templates (might be dropped in favour of 3rd party packages focusing on this)

generate_yaml_from_directory(): Generate YAML File from Directory Structure

copy_folder_contents_to_dir(): Convenience Function to Copy Only the Contents of A Folder to Another Folder

create_directory_structure(): Create a Pre-defined Directory Hierarchy on Disk

create_r_files(): Create Folder with Placeholder R-files Based on Structure in CSV-file

Internal functions used by other packages

filename_sanitizer(): File/folder name sanitizer replacing space and punctuation with underscore

get_raw_labels(): Helper function to extract raw variable labels from the data

is_string(): Is x A String?