Retrive a YAML-formatted glossary from the web or locally.

get_glossary(
  url = "https://raw.githubusercontent.com/carpentries/glosario/master/glossary.yml",
  cache = tempdir()
)

Arguments

url

the url, path for the glossary or the OWNER/REPO for a GitHub repository that hosts a glossary.

cache

the local path to cache the glossary (default: tempdir())?

Value

a glossary (as an R6 object)

Details

The specification of the file is available from https://github.com/carpentries/glosario/#readme

If <OWNER/REPO> is provided to the url argument, the successful conversion into an URL that will resolve to a glossary assumes that the glossary is called glossary.yml in the repository and it lives in the branch master.x