glossary: Glossary class

In zachary-foster/glossary:

Description

This is used to add terms to a glossary

Usage

glossary(definitions_path, glossary_path = "", terms_used = c(),
  header_level = 3)

Arguments

definitions_path	Where the the definitions of terms are stored. This is used to show the definitions when hovering over a glossary term in the text.
glossary_path	The file the glossary will be added to. This is used to link glossary terms in the text to their definitions in the rendered glossary.
terms_used	The terms that will be used. Adding terms to the constructor (instead of 'my_gloss$add("new term")') will include them as if they were added with 'my_gloss$add()'.
header_level	How big the headers are for each term in the rendered glossary. Larger numbers mean smaller titles.

Value

An 'R6Class' object of class 'Glossary'

Examples

## Not run: 
my_gloss <- glossary()

## End(Not run)

zachary-foster/glossary documentation built on May 23, 2019, 7:04 p.m.