Check that this machine can render a mariner report

Checks what a report needs: Quarto, a LaTeX engine, the fonts, the project folders, the theme, and the packages the template loads. One line per check, with the fix to paste for anything that is wrong.

Usage

mariner_check_setup(
  root = NULL,
  theme = mariner_themes,
  template = "report",
  quiet = FALSE
)

Arguments

root

Project root to check. NULL (the default) resolves it with mariner_project_root().

theme

One of mariner_themes.

template

Starter template whose package dependencies to check.

quiet

Return the data frame without printing it.

Value

Invisibly, a data frame with one row per check and the columns check, status ("ok", "warn" or "fail"), detail and remedy.

Details

Nothing is installed or changed. You run the remedies.

What the statuses mean

ok

Nothing to do.

warn

The report renders, but not as intended. Usually the figures come out in the device's default typeface while the page text does not.

fail

The render will not complete.

See also

mariner_setup_project(), mariner_install_fonts()

Examples

if (FALSE) { # \dontrun{
mariner_check_setup()

# Just the problems:
report <- mariner_check_setup(quiet = TRUE)
subset(report, status != "ok")
} # }