Ottrpal Checks — ottr_check • ottrpal

Ottrpal Checks

ottr_check(
  check_type,
  path = ".",
  output_dir = "check_reports",
  resources_dir = "resources",
  ...
)

Arguments

check_type: What check would you like to run "spelling", "urls" or "quiz_format".
path: path to the bookdown or quarto course repository, must have a `.github` folder which will be used to establish the top of the repo.
output_dir: A relative file path to the folder (existing or not) that the output check file should be saved to. Default is "check_reports"
resources_dir: A relative file path to the folder (existing or not) that the dictionary.txt file and exclude_files.txt will be found. Default is "resources". If no dictionary.txt file and exclude_files.txt files are found, we will download one.
...: All additional arguments passed to the respective check

The result of the check being called