ottrpal contains tools and functions to be used with an OTTR repository course. It converts an OTTR course (Open-Source Tools for Training Resources) into a files ready for upload to Massive Open Online Courses (MOOCs): Coursera and Leanpub.
You can install
ottrpal from CRAN or from GitHub.
Book.txtfile which lists the order of the chapters/quiz files (this can be autogenerated with
ottrpal) (see example file).
.mdfiles which have been written using the Markua formatting specifications (see example folder).
img_pathSee this (https://github.com/jhudsl/OTTR_Template/blob/main/resources/chapt_screen_images/chapter_urls.tsv).
Follow the instructions here to set up your own OTTR GitHub repository for a new course.
In the base of your OTTR repository, you can run this command to set up a Leanpub version of your course. The
ottrpal package converts your files using this base function, where
base_url is where the OTTR course pages are published, the GitHub pages URL.
ottrpal::bookdown_to_embed_leanpub(base_url = "https://jhudatascience.org/OTTR_Template/")
ottrpal will re-run a
bookdown::render_book("index.Rmd") rendering of your chapters first before converting the files to the Leanpub ready format. However, if you wish to skip this step, you can set
render = FALSE when running the
Leanpub requires a
Book.txt file to know what order the chapters/quizzes should be published.
By default, your
Book.txt file will not be autogenerated but
ottrpal will look in your given directory for an existing
Book.txt file which it will copy over to the output directory.
You can create a
Book.txt file manually, or if your quizzes and chapters are numbered,
ottrpal can create the
Book.txt file based on the numbers going from low to high and quizzes following chapters of the same number. (e.g.
quiz_03.md will be placed after
ottrpal attempt to autogenerate this file, set
ottrpal::bookdown_to_embed_leanpub(base_url = "https://jhudatascience.org/OTTR_Template/", make_book_txt = TRUE)
Book.txt file is found and
make_book_txt is set to
FALSE (this is the default setting),
ottrpal will fail.
Book.txt file might look something like this:
index.Rmd 01-chapter.Rmd quiz_1.md 02-chapter.Rmd quiz_2.md about.Rmd
Also note that any
index.Rmd will always be placed first and any
about.Rmd file will be placed last.
By default, ottrpal will look for a folder called
quizzes/ to find your quiz
.md files. If your quizzes are located somewhere else, you will need to use the
quiz_dir argument to specify that:
ottrpal::bookdown_to_embed_leanpub(base_url = "https://jhudatascience.org/OTTR_Template/", make_book_txt = TRUE, quiz_dir = "some_directory")
If you don’t have quizzes, you can say
quiz_dir = NULL to skip all quiz steps.
Leanpub’s Github writing mode will look for a directory called
manuscript to publish from. You should not edit the files in
manuscript/ by hand since a re-run of
ottrpal will cause your changes to be overwritten.