Package index

Setup and Scaffolding

Create the project folders and check the machine.

mariner_check_setup()

Check that this machine can render a mariner report

mariner_setup_project()

Set up a mariner project

mariner_dirs()

The mariner project folders

mariner_project_root()

Locate the project root

mariner_looks_like_project()

Does this directory look like a project root?

mariner_install_fonts()

Install the bundled fonts for this user

Template and Generation

Write .qmd sources from a template.

generate_reports()

Create Quarto sources from a template

mariner_templates()

Available mariner templates

mariner_template_path()

Path to a mariner template skeleton

Rendering and Bundling

Render the documents and bundle them.

process_file()

Bundle a Quarto file and its outputs

process_files()

Bundle many Quarto files, in sequence or in parallel

Theming and Palettes

Brand colours, the ggplot2 theme, and chunk options.

theme_mariner()

Branded ggplot2 theme for mariner

mariner_set_theme()

Set global ggplot2 theme and scale defaults

mariner_colors()

Named colour vector for a theme

mariner_pal()

Brand palette generator

mariner_knitr_setup()

Global knitr setup for branded Quarto documents

mariner_fig_dims()

Figure dimensions for a branded report

mariner_themes

Themes shipped by mariner

mariner_formats

Formats shipped by mariner

Scales

ggplot2 scales over the brand palettes.

scale_colour_mariner_b() scale_color_mariner_b() scale_fill_mariner_b()

Binned colour and fill scales for mariner

scale_colour_mariner_c() scale_color_mariner_c() scale_fill_mariner_c()

Continuous colour and fill scales for mariner

scale_colour_mariner_d() scale_color_mariner_d() scale_fill_mariner_d()

Discrete colour and fill scales for mariner

scale_colour_mariner_div() scale_color_mariner_div() scale_fill_mariner_div()

Diverging colour and fill scales for mariner

scale_colour_mariner_o() scale_color_mariner_o() scale_fill_mariner_o()

Ordinal colour and fill scales for mariner