ottrpal package

ottrpal is a companion R package for OTTR courses (Open-source Tools for Training Resources).

Go to ottrproject.org to get started! 🎉

• Perform URL, spell, and formatting checks for your Quarto and R markdown, and markdown files.
• Prep your courses for upload to Massive Open Online Courses (MOOCs): Coursera and Leanpub.
• ottrfy() your course to make it ready for all the OTTR functionality.

Installing ottrpal:

You can install ottrpal from Cran with:

install.packages("ottrpal")

If you want the development version (not advised) you can install using the remotes package to install from GitHub.

if (!("remotes" %in% installed.packages())) {
  install.packages("remotes")
}
remotes::install_github("ottrproject/ottrpal")

Using ottrpal through Docker

There are a few options at this time. The ottrpal Docker image will execute at the mount location so you can either have your working directory and use the commands below or you can point your volume to your specific OTTR repo by replacing $PWD with the relative file path tot the top of your directory (what should contain the index.Rmd or index.qmd etc).

Using the executable Docker image works like this:

docker run -v $PWD:/home jhudsl/ottrpal:dev command_of_choice

You can run checks: "spelling", "urls", "quiz_format" by putting one of these options in there

docker run -v $PWD:/home jhudsl/ottrpal:dev spelling

Or you can render OTTR websites using "rmd", "quarto", "quarto_web", or "rmd_web"

docker run -v $PWD:/home jhudsl/ottrpal:dev rmd