Package index • saros

The main function you will use

You use this function with the type-argument to create most things you’ll need.

makeme(): Embed Interactive Plot of Various Kinds Using Tidyselect Syntax

Get, set and reset global options

Global options allow you to easily set defaults for all your makeme function calls, so you basically do not need to specify the same arguments throughout. data, dep and indep will still need to be specified.

global_settings_get(): Get Global Options for saros-functions
global_settings_set(): Get Global Options for saros-functions
global_settings_reset(): Reset Global Options for saros-functions

Gets the possible data_label and type options for the makeme()-arguments

get_data_label_opts(): Get Valid Data Labels for Figures and Tables
get_makeme_types(): Get all registered options for the type-argument in the makeme-function

Save output and create a link to it on rendering

make_link(): Save data to a file and return a Markdown link
make_link(<default>): Save data to a file and return a Markdown link
make_link(<list>): Save data to a file and return a Markdown link
make_file_links(): Create Markdown Links to Files with Document Titles
ggsaver(): Wrapper Function for ggplot2::ggsave() with Palette Support
quarto_pdf_post_render(): Quarto Post-Render: Enrich PDF Files with DOCX Titles
check_quarto_website_index(): Check Quarto Website Folders for Missing index.qmd

Read and write tabular data

Functions for reading and writing data frames to various file formats

tabular_read(): Read tabular data from various formats
tabular_write(): Write tabular data to various formats

Advanced Palette-Retrieving ggiraph::girafe wrapper

girafe(): Pull global plotting settings before displaying plot

Generate figure captions and Quarto tabsets

crowd_output(): Universal Output Function for Crowd Plots and Tables
is_rendering(): Detect if Running in knitr/Quarto Rendering Context
get_fig_title_suffix_from_ggplot(): Generate Figure Title Suffix with N Range and Optional Download Links
crowd_plots_as_tabset(): Convert List of Plots to Quarto Tabset
crowd_plots_as_officer(): Convert List of Plots to officer-Compatible Format
crowd_plots_as_docx(): Write Plots to Word Document (DOCX)
crowd_tables_as_tabset(): Convert List of Tables to Quarto Tabset

Compute optimal figure heights for the built-in cat_plot

fig_height_h_barchart(): Estimate figure height for a horizontal bar chart
fig_height_h_barchart2() fig_height_h_barchart2.ggplot() fig_height_h_barchart2.ms_chart() fig_height_h_barchart2.default(): Estimate figure height for a horizontal bar chart

Obtain sample size range for a makeme-object (experimental)

n_range(): Provides a range (or single value) for N in data, given dep and indep
n_range2() n_range2.ggplot() n_range2.ms_chart() n_range2.default(): Provides a range (or single value) for N in a plot object from makeme()

Retrieve metadata attached to saros output objects

get_dep_label_prefix(): Retrieve the dep label prefix from a saros output object

Convert cat_plot-object to simple conditional text interpretations

txt_from_cat_mesos_plots(): Extract Text Summary from Categorical Mesos Plots

Insert text from a data frame by chunk name

insert_text(): Insert Text from a Data Frame by Chunk Name

Detect the current output format

output_format(): Detect the Current Output Format

Only relevant when expanding the S3 system with your own functions

make_content(): Method for Creating Saros Contents

Example dataset

ex_survey: ex_survey: Mockup dataset of a survey.