make_screenshots: A function to make screenshots from an OTTR bookdown website

In ottrpal: Companion Tools for Open-Source Tools for Training Resources (OTTR)

A function to make screenshots from an OTTR bookdown website

Description

This function creates screenshots of course chapters that are stored in a created output directory

Usage

make_screenshots(
  path = ".",
  token,
  repo,
  output_dir = file.path(path, "resources", "chapt_screen_images"),
  base_url = NULL
)

Arguments

path	default is to look for OTTR files in current directory based on existence of .github. But if you'd like to run this in a different path, you can point to that file path.
token	required argument; a Git secret – see https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens for more info
repo	required argument; GitHub repository name, e.g., jhudsl/OTTR_Template
output_dir	default is "resources/chapt_screen_images"; Output directory where the chapter's screen images should be stored. For OTTR courses, don't change this unless you've changed the downstream functions accordingly.
base_url	default is NULL; rendered bookdown URL where screenshots are taken from, if NULL, the function will use the repo_name and and token to find the base_url

Value

the file path for file where chapter urls are saved

Author(s)

Candace Savonen

Examples

## Not run: 

make_screenshots(
  token = Sys.getenv("secrets.GH_PAT"),
  repo = "jhudsl/OTTR_Template"
)

## End(Not run)

ottrpal documentation built on April 3, 2025, 7:46 p.m.