https://github.com/jhudsl/ottrpal
Tools for converting OTTR courses into Leanpub or Coursera courses :otter:
https://github.com/jhudsl/ottrpal
edtech-software
Last synced: over 1 year ago
JSON representation
Tools for converting OTTR courses into Leanpub or Coursera courses :otter:
- Host: GitHub
- URL: https://github.com/jhudsl/ottrpal
- Owner: jhudsl
- License: gpl-3.0
- Created: 2021-04-27T20:06:51.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-30T19:20:39.000Z (over 1 year ago)
- Last Synced: 2025-02-23T17:15:05.938Z (over 1 year ago)
- Topics: edtech-software
- Language: R
- Homepage: https://jhudatascience.org/ottrpal/
- Size: 110 MB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/jhudsl/ottrpal/actions) [](https://CRAN.R-project.org/package=ottrpal) [](https://cran.r-project.org/package=ottrpal) [](https://lifecycle.r-lib.org/articles/stages.html#stable)
# Intro to ottrpal package
`ottrpal` converts an [OTTR course](https://www.ottrproject.org/index.html#ottr-for-courses) (Open-source Tools for Training Resources) into a files ready for upload to Massive Open Online Courses (MOOCs): [Coursera](https://www.coursera.org/) and [Leanpub](https://leanpub.com/).
- Go to the [main OTTR guide](https://www.ottrproject.org/) for how to start creating courses with OTTR.
- [Read the ottrpal package documentation here](https://jhudatascience.org/ottrpal/docs/index.html).
## Using the example repository:
If you'd like to use our example repository you can fork it on Github and clone it to your own computer
[Follow these instructions to fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) and then you can clone it using a command like:
```{sh}
git clone https://github.com/{organization}/OTTR_Quizzes.git
```
But replace `{organization}` with the location of your forked repository.
## Installing ottrpal:
You can install `ottrpal` from GitHub with:
```
install.packages("ottrpal")
```
If you want the development version (not advised) you can install using the `remotes` pacakge to install from GitHub.
``` r
if (!("remotes" %in% installed.packages())) {
install.packages("remotes")
}
remotes::install_github("jhudsl/ottrpal")
```
## Running ottrpal
The `ottrpal` package converts your files using one of these main functions:
```{r}
ottrpal::bookdown_to_embed_leanpub()
```
By default, `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 `ottrpal::bookdown_to_embed_leanpub()` function.
## About the Book.txt file:
Leanpub requires a [`Book.txt`](https://leanpub.com/lfm/read#leanpub-auto-booktxt-sampletxt-and-manuscript-files) 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 `03-some_chapter_file.Rmd`).
To have `ottrpal` attempt to autogenerate this file, set `make_book_txt` to `TRUE`.
```{r}
ottrpal::bookdown_to_embed_leanpub(make_book_txt = TRUE)
```
If no `Book.txt` file is found and `make_book_txt` is set to `FALSE` (this is the default setting), `ottrpal` will fail.
A ottrpal autogenerated `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.
## Setting up quizzes:
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:
```{r}
ottrpal::bookdown_to_embed_leanpub(quiz_dir = "some_directory")
```
## About the output files
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.
## Adding footer text:
If there is text you would like added to the end of each chapter (like a link to a feedback survey for example), you can supply a character string to the `footer_text`argument in the main `ottrpal::bookdown_to_leanpub()` function.
```{r}
# Set up a character string
survey_link <- "Please provide any feedback you have by filing a GitHub issue [here](https://github.com/jhudsl/OTTR_Template/issues)"
# Supply the footer text in the main function
ottrpal::bookdown_to_embed_leanpub(footer_text = survey_link)
```