saros.base1.0.0 package

Base Tools for Semi-Automatic Reporting of Ordinary Surveys

add_n_range_to_chapter_structure

Add Sample Size Range to Chapter Structure

copy_folder_contents_to_dir

Convenience Function to Copy Only the Contents of A Folder to Another ...

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

download_zip_to_folder

Wrapper to Download and Unzip a Github Repository to A Folder

draft_report

Automatically Draft a Quarto Report

filename_sanitizer

File/folder name sanitizer replacing space and punctuation with unders...

gen_qmd_chapters

Generate A Quarto Survey Report

gen_qmd_file

Generate Quarto Index File That Merges All Chapters

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

handle_max_observed

Handle Maximum Observed Numbering

handle_naming_conventions

Handle Naming Conventions

handle_numbering_inheritance

Handle numbering inheritance

initialize_saros_project

Initialize Folder Structure

insert_chunk

Mass Create Elements of A Certain Type

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.

render_full_reports

Post-render rendering of complete reports

setup_access_restrictions

Setup files needed for basic password-based access restriction for web...

setup_mesos

Simply create qmd-files and yml-files for mesos reports

write_default_draft_report_args

Write Default Arguments for draft_report() to YAML-file

Scaffold an entire web-based report using template chunks, based on a small chapter overview and a dataset. Highly adaptable with prefixes, suffixes, translations, etc. Also contains tools for password-protecting, e.g. for each organization's report on a website. Developed for the common case of a survey across multiple organizations/sites where each organization wants to obtain results for their organization compared with everyone else. See 'saros' (<https://CRAN.R-project.org/package=saros>) for tools used for authors in the drafted reports.

  • Maintainer: Stephan Daus
  • License: MIT + file LICENSE
  • Last published: 2025-01-10