The goal of {glossary} is to provide a glossary of statistical and R coding terms used in the PsyTeachR books that can be accessed offline.

You can install the development version of glossary from GitHub with:

# install.packages("devtools")
devtools::install_github("psyteachr/glossary")

glossary::open_glossary()

You can use the glossary to define terms in a markdown document. By default, the term links to the online glossary and shows a short definition when you hover over the link. You can change what text displays in the link, what the short definition displays, whether the link opens the online glossary, and whether it’s added to the glossary table.

• glossary("alpha"): alpha
• glossary("beta", display = "β"): β
• glossary("power", def = "custom definition of power"): power
• glossary("probability", def = ""): probability
• glossary("p-value", link = FALSE): p-value
• glossary("replicability", add_to_table = FALSE): replicability

You can include a glossary table at the end of a document that includes all of the terms you defined above.

glossary_table()

If you add or change any terms in the glossary, you will need to recompile it. Here are two ways to do this, either through a running R session or from a terminal prompt.

From the R console, with the working directory set to the root directory of the glossary repository, type

source("_makefile.R")

In a terminal window, navigate to the directory containing the glossary files and type

make

This will invoke the commands in Makefile.