Base Tools for Semi-Automatic Reporting of Ordinary Surveys


[Up] [Top]

Documentation for package ‘saros.base’ version 1.2.0

Help Pages

check_variable_labels Check Variable Labels for Saros Use
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_email_credentials Create Data Frame Containing Email Drafts with User Credentials
create_r_files Create Folder with Placeholder R-files Based on Structure in CSV-file
detect_malformed_quarto_project Detect malformed Quarto website projects generated by saros.base
download_zip_to_folder Wrapper to Download and Unzip a Github Repository to A Folder
draft_report Automatically Draft a Quarto Report
ex_survey ex_survey: Mockup dataset of a survey.
ex_survey_ch_overview ex_survey_ch_overview: Mock overview of chapter structure
filename_sanitizer File/folder name sanitizer replacing space and punctuation with underscore
generate_yaml_from_directory Generate YAML File from Directory Structure
get_chunk_template_defaults Get Global Options for Chunk Templates
get_organize_by_opts Get Core Chapter Structure Column Names
get_raw_labels Helper function to extract raw variable labels from the data
initialize_saros_project Initialize Folder Structure
is_string Is x A String?
read_default_draft_report_args Read Default Arguments for 'draft_report()' from YAML-file
refine_chapter_overview Processes A 'chapter_overview' Data Frame
remove_entry_from_sidebar Removes entries in sidebar if containing a filename regex pattern.
sanitize_chr_vec Sanitize character vector, for instance useful for variable label in 'labelled::update_variable_labels_with()'
setup_access_restrictions Setup files needed for basic password-based access restriction for website
setup_mesos Simply create qmd-files and yml-files for mesos reports
setup_mesos_structure Create directory structure for mesos reports (improved version)
write_default_draft_report_args Write Default Arguments for 'draft_report()' to YAML-file