-
+
@@ -124,7 +124,7 @@
diff --git a/inst/extdata/01-intro.Rmd b/inst/extdata/01-intro.Rmd
index 6dbc5b9..8f24ffe 100644
--- a/inst/extdata/01-intro.Rmd
+++ b/inst/extdata/01-intro.Rmd
@@ -3,7 +3,7 @@ title: "Course Title"
---
```{r, include = FALSE}
-leanbuild::set_knitr_image_path()
+ottr::set_knitr_image_path()
```
# Introduction
diff --git a/inst/extdata/02-example-chapter.Rmd b/inst/extdata/02-example-chapter.Rmd
index ff2e72a..c32c516 100644
--- a/inst/extdata/02-example-chapter.Rmd
+++ b/inst/extdata/02-example-chapter.Rmd
@@ -7,7 +7,7 @@ title: "Example Chapter"
Every chapter needs to start out with this chunk of code:
```{r, include = FALSE}
-leanbuild::set_knitr_image_path()
+ottr::set_knitr_image_path()
```
### Code examples
@@ -41,7 +41,7 @@ dev.off()
How to include a Google slide.
```{r, fig.align='center', echo = FALSE, fig.alt= "Major point!! example image"}
-leanbuild::include_slide("https://docs.google.com/presentation/d/1YmwKdIy9BeQ3EShgZhvtb3MgR8P6iDX4DfFD65W_gdQ/edit#slide=id.gcc4fbee202_0_141")
+ottr::include_slide("https://docs.google.com/presentation/d/1YmwKdIy9BeQ3EShgZhvtb3MgR8P6iDX4DfFD65W_gdQ/edit#slide=id.gcc4fbee202_0_141")
```
But if you have the slide or some other image locally downloaded you can also use html like this:
diff --git a/man/bookdown_to_leanpub.Rd b/man/bookdown_to_leanpub.Rd
index 5f0a11d..552cf8c 100644
--- a/man/bookdown_to_leanpub.Rd
+++ b/man/bookdown_to_leanpub.Rd
@@ -24,7 +24,7 @@ bookdown_to_leanpub(
\item{output_dir}{output directory to put files. It should likely be
relative to path}
-\item{make_book_txt}{Should [leanbuild::bookdown_to_book_txt()] be run
+\item{make_book_txt}{Should [ottr::bookdown_to_book_txt()] be run
to create a `Book.txt` in the output directory?}
\item{quiz_dir}{directory that contains the quiz .md files that should be
diff --git a/man/check_all_questions.Rd b/man/check_all_questions.Rd
index c05e4d3..e1520a6 100644
--- a/man/check_all_questions.Rd
+++ b/man/check_all_questions.Rd
@@ -7,17 +7,17 @@
check_all_questions(quiz_specs, quiz_name = NA, verbose = TRUE)
}
\arguments{
-\item{quiz_specs}{quiz_specs which is output from [leanbuild::parse_quiz].}
+\item{quiz_specs}{quiz_specs which is output from [ottr::parse_quiz].}
\item{quiz_name}{The name of the quiz being checked.}
\item{verbose}{Whether progress messages should be given.}
}
\value{
-A list of the output from [leanbuild::check_question] with messages/warnings regarding each question and each check.
+A list of the output from [ottr::check_question] with messages/warnings regarding each question and each check.
}
\description{
-Takes output from [leanbuild::parse_quiz] and runs checks on each question in a quiz by calling [leanbuild::check_question] for each question.
+Takes output from [ottr::parse_quiz] and runs checks on each question in a quiz by calling [ottr::check_question] for each question.
First splits questions into their own data frame. Returns a list of messages/warnings about each question's set up.
}
\examples{
diff --git a/man/check_question.Rd b/man/check_question.Rd
index 74e93cf..bc9695c 100644
--- a/man/check_question.Rd
+++ b/man/check_question.Rd
@@ -19,7 +19,7 @@ A list of messages/warnings regarding each check for the given question.
\description{
Check quiz question set up to see if it is compliant with Leanpub and Coursera needs.
Based off of [Markua guide](https://leanpub.com/markua/read#leanpub-auto-quizzes-and-exercises).
-Is called by [leanbuild::check_all_questions] and run for each question.
+Is called by [ottr::check_all_questions] and run for each question.
}
\examples{
diff --git a/man/check_quiz_attributes.Rd b/man/check_quiz_attributes.Rd
index 4e8e98e..6821243 100644
--- a/man/check_quiz_attributes.Rd
+++ b/man/check_quiz_attributes.Rd
@@ -7,7 +7,7 @@
check_quiz_attributes(quiz_specs, quiz_name = NULL, verbose = TRUE)
}
\arguments{
-\item{quiz_specs}{The output from [leanbuild::parse_quiz].}
+\item{quiz_specs}{The output from [ottr::parse_quiz].}
\item{quiz_name}{A character string indicating the name of the quiz being checked.}
diff --git a/man/check_quiz_question_attributes.Rd b/man/check_quiz_question_attributes.Rd
index 934ff22..8b38759 100644
--- a/man/check_quiz_question_attributes.Rd
+++ b/man/check_quiz_question_attributes.Rd
@@ -7,13 +7,13 @@
check_quiz_question_attributes(question_df, quiz_name = NULL, verbose = TRUE)
}
\arguments{
-\item{question_df}{a data.frame obtained from [leanbuild::parse_quiz_df] and dplyr::group_split(question).}
+\item{question_df}{a data.frame obtained from [ottr::parse_quiz_df] and dplyr::group_split(question).}
\item{quiz_name}{inherited from parse}
\item{verbose}{print diagnostic messages}
}
\description{
-This is ran automatically by [leanbuild::check_all_questions] for all questions.
+This is ran automatically by [ottr::check_all_questions] for all questions.
It checks that the attributes specified are accepted ones by Leanpub.
}
diff --git a/man/check_quizzes.Rd b/man/check_quizzes.Rd
index bda0d9d..8fff7d6 100644
--- a/man/check_quizzes.Rd
+++ b/man/check_quizzes.Rd
@@ -7,7 +7,7 @@
check_quizzes(quiz_dir = "quizzes", write_report = TRUE, verbose = TRUE)
}
\arguments{
-\item{quiz_dir}{A path to a directory full of quizzes that should all be checked with [leanbuild::check_all_quizzes].}
+\item{quiz_dir}{A path to a directory full of quizzes that should all be checked with [ottr::check_all_quizzes].}
\item{write_report}{TRUE/FALSE save warning report to a CSV file?}
diff --git a/man/example_repo_cleanup.Rd b/man/example_repo_cleanup.Rd
index f0096bc..f9cc301 100644
--- a/man/example_repo_cleanup.Rd
+++ b/man/example_repo_cleanup.Rd
@@ -17,7 +17,7 @@ Clean up example repo files
\examples{
# Run this to get the files we need
-example_files <- leanbuild::example_repo_setup()
+example_files <- ottr::example_repo_setup()
# Run this to delete them
example_repo_cleanup(files_to_remove = basename(example_files))
diff --git a/man/example_repo_setup.Rd b/man/example_repo_setup.Rd
index 1bb3bdf..c9cc03a 100644
--- a/man/example_repo_setup.Rd
+++ b/man/example_repo_setup.Rd
@@ -14,5 +14,5 @@ Set up example repo files
}
\examples{
# Run this to get the files we need
-example_files <- leanbuild::example_repo_setup()
+example_files <- ottr::example_repo_setup()
}
diff --git a/man/remove_yaml_header.Rd b/man/remove_yaml_header.Rd
index fbfee87..5ad4e59 100644
--- a/man/remove_yaml_header.Rd
+++ b/man/remove_yaml_header.Rd
@@ -16,7 +16,7 @@ A character vector of the text without the YAML header
Remove YAML header
}
\examples{
-file <- system.file("extdata/00_template.Rmd", package = "leanbuild")
+file <- system.file("extdata/00_template.Rmd", package = "ottr")
out <- remove_yaml_header(file)
head(out)
}
diff --git a/tests/testthat.R b/tests/testthat.R
index 8787609..ff6b117 100644
--- a/tests/testthat.R
+++ b/tests/testthat.R
@@ -1,4 +1,4 @@
library(testthat)
-library(leanbuild)
+library(ottr)
-test_check("leanbuild")
+test_check("ottr")
diff --git a/tests/testthat/test-gs_download.R b/tests/testthat/test-gs_download.R
index cb88bc2..ac86f07 100644
--- a/tests/testthat/test-gs_download.R
+++ b/tests/testthat/test-gs_download.R
@@ -1,6 +1,6 @@
testthat::test_that("Download a Slide ", {
output_dir = tempdir()
- outfile = leanbuild::include_slide(
+ outfile = ottr::include_slide(
paste0("https://docs.google.com/presentation/d/",
"12DPZgPteQBwgal6kSPP58zhPhjZ7QSPZLe3NkA8M3eo/",
"edit#slide=id.gc87451c247_0_17"),
diff --git a/vignettes/getting-started.Rmd b/vignettes/getting-started.Rmd
index c85d89b..39b674e 100644
--- a/vignettes/getting-started.Rmd
+++ b/vignettes/getting-started.Rmd
@@ -7,16 +7,16 @@ vignette: >
%\VignetteEncoding{UTF-8}
---
-# Intro to leanbuild
+# Intro to ottr
-`leanbuild` converts a [Bookdown repository](https://github.com/jtr13/bookdown-template) into a [Leanpub-ready](https://leanpub.com/) set of files.
+`ottr` converts a [Bookdown repository](https://github.com/jtr13/bookdown-template) into a [Leanpub-ready](https://leanpub.com/) set of files.
The output rendered files from this package can be published using the [Github writing mode on Leanpub](https://leanpub.com/lfm/read#leanpub-auto-switching-writing-modes).
If you aren't familiar with `Bookdown` you may want with [their tutorials](https://bookdown.org/yihui/bookdown/).
-## Installing leanbuild:
+## Installing ottr:
-You can install `leanbuild` from GitHub with:
+You can install `ottr` from GitHub with:
You will need to use the remotes package (and will need to install it if you don't have it).
@@ -24,24 +24,24 @@ You will need to use the remotes package (and will need to install it if you don
if (!("remotes" %in% installed.packages())) {
install.packages("remotes")
}
-if (!("leanbuild" %in% installed.packages())) {
- remotes::install_github("jhudsl/leanbuild")
+if (!("ottr" %in% installed.packages())) {
+ remotes::install_github("jhudsl/ottr")
}
```
## Required files:
-Before you are ready to run `leanbuild`, you will need the following files (which are standard in a `Bookdown` repository):
+Before you are ready to run `ottr`, you will need the following files (which are standard in a `Bookdown` repository):
- a `_bookdown.yml` file which lists the `.Rmd` files that are to be rendered in a `rmd: ` category (see [example file](https://github.com/jhudsl/OTTR_Quizzes/blob/main/_bookdown.yml)).
- `.Rmd` files which contain the chapter content (including your `index.Rmd` file which `Bookdown` has).
- an `images` directory that contains any images that are referenced in the chapters.
- `.bib` file(s) to complete any citation renders (see [example file](https://github.com/jhudsl/OTTR_Quizzes/blob/main/book.bib)).
_Optionally:_.
-- [a `Book.txt` file](https://leanpub.com/lfm/read#leanpub-auto-booktxt-sampletxt-and-manuscript-files) which lists the order of the chapters/quiz files (this can be autogenerated with `leanbuild`) (see [example file](https://github.com/jhudsl/OTTR_Quizzes/blob/main/Book.txt)).
+- [a `Book.txt` file](https://leanpub.com/lfm/read#leanpub-auto-booktxt-sampletxt-and-manuscript-files) which lists the order of the chapters/quiz files (this can be autogenerated with `ottr`) (see [example file](https://github.com/jhudsl/OTTR_Quizzes/blob/main/Book.txt)).
- a directory containing quizzes in the form of `.md` files which have been written using the [Markua formatting specifications](https://leanpub.com/markua/read#leanpub-auto-quizzes-and-exercises) (see [example folder](https://github.com/jhudsl/OTTR_Quizzes/tree/main/quizzes)).
-Here's an example of what the Bookdown file set up (which leanbuild will look for) might be set up like:
+Here's an example of what the Bookdown file set up (which ottr will look for) might be set up like:
```
A_Bookdown_Repo
├── _bookdown.yml
@@ -68,53 +68,53 @@ But for the purposes of this example we will download a zip file of the files we
```{r}
# Run this to get the files we need
-example_files <- leanbuild::example_repo_setup()
+example_files <- ottr::example_repo_setup()
```
Each of your Rmds needs to have a chunk of code with this at the beginning of the file:
-`leanbuild::set_knitr_image_path()`
+`ottr::set_knitr_image_path()`
This will ensure that the images are stored in the correct place and will be rendered correctly both in `Bookdown` and in Leanpub.
-## Running leanbuild
+## Running ottr
-The `leanbuild` package converts your files using this main function (which we won't run just yet).
+The `ottr` package converts your files using this main function (which we won't run just yet).
```
-leanbuild::bookdown_to_leanpub()
+ottr::bookdown_to_leanpub()
```
-By default, `leanbuild` will re-run a `bookdown::render_book("index.Rmd")` rendering of your chapters first before converting the files to the Leanpub ready format.
+By default, `ottr` will re-run a `bookdown::render_book("index.Rmd")` rendering of your chapters first before converting the files to the Leanpub ready format.
It will only process the `Rmd` files that are listed in the `_bookdown.yml` file.
-However, if you wish to skip this step, you can set `render = FALSE` when running the `leanbuild::bookdown_to_leanpub()` function.
+However, if you wish to skip this step, you can set `render = FALSE` when running the `ottr::bookdown_to_leanpub()` function.
## 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 `leanbuild` will cause your changes to be overwritten.
+You should not edit the files in `manuscript/` by hand since a re-run of `ottr` will cause your changes to be overwritten.
## 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 `leanbuild` will look in your given directory for an existing `Book.txt` file which it will copy over to the output directory.
+By default, your `Book.txt` file will _not_ be autogenerated but `ottr` 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, `leanbuild` can create the `Book.txt` file based on the numbers going from low to high and quizzes following chapters of the same number.
+You can create a `Book.txt` file manually, or if your quizzes and chapters are numbered, `ottr` 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 `leanbuild` attempt to autogenerate this file with the main function you can set `make_book_txt` to `TRUE`.
-If no `Book.txt` file is found and `make_book_txt` is set to `FALSE` (this is the default setting), `leanbuild` will fail.
+To have `ottr` attempt to autogenerate this file with the main function you can set `make_book_txt` to `TRUE`.
+If no `Book.txt` file is found and `make_book_txt` is set to `FALSE` (this is the default setting), `ottr` will fail.
So to run the main function and also have it make a `Book.txt` file for us, we can run the following: For now we don't have quizzes, so we will set `quiz_dir = NULL`.
```{r}
-leanbuild::bookdown_to_leanpub(make_book_txt = TRUE, quiz_dir = NULL)
+ottr::bookdown_to_leanpub(make_book_txt = TRUE, quiz_dir = NULL)
```
Alternatively, we could run `bookdown_to_book_txt()` function on its own:
```{r}
-leanbuild::bookdown_to_book_txt()
+ottr::bookdown_to_book_txt()
```
Also note that any `index.Rmd` will always be placed first and any `about.Rmd` file will be placed last.
@@ -137,11 +137,11 @@ if(!dir.exists(quiz_dir)) {
}
```
-By default, leanbuild will look for a folder called `quizzes/` to find your quiz `.md` files.
+By default, ottr 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:
```
-leanbuild::bookdown_to_leanpub(quiz_dir = "some_other_directory")
+ottr::bookdown_to_leanpub(quiz_dir = "some_other_directory")
```
Leanpub can be very particular about the formatting of the quizzes, so there are funtions to help you check the formatting of your quiz.
@@ -149,7 +149,7 @@ Leanpub can be very particular about the formatting of the quizzes, so there are
In the main argument, you can set `run_quiz_checks` to `TRUE` (the default is `FALSE`).
```
-leanbuild::bookdown_to_leanpub(run_quiz_checks = TRUE)
+ottr::bookdown_to_leanpub(run_quiz_checks = TRUE)
```
But the quiz checks can also be run separately using the `check_quizzes()` function.
@@ -159,7 +159,7 @@ We can take a look at how `check_quizzes()` runs using a quiz examples: one that
```{r}
# Set up an good example quiz
-good_quiz_path <- leanbuild::good_quiz_path()
+good_quiz_path <- ottr::good_quiz_path()
dest_quiz_path <- file.path("quizzes", basename(good_quiz_path))
@@ -172,7 +172,7 @@ if (!file.exists(dest_quiz_path)){
Run `check_quizzes()` to check all quizzes in the directory.
```{r}
-quiz_checklist <- leanbuild::check_quizzes(quiz_dir = "quizzes")
+quiz_checklist <- ottr::check_quizzes(quiz_dir = "quizzes")
```
We can take a look at what a typical quiz format looks like:
@@ -186,7 +186,7 @@ Now let's add in a bad quiz and see how the report changes.
```{r}
# Set up an good example quiz
-bad_quiz_path <- leanbuild::bad_quiz_path()
+bad_quiz_path <- ottr::bad_quiz_path()
dest_quiz_path <- file.path("quizzes", basename(bad_quiz_path))
@@ -199,7 +199,7 @@ if (!file.exists(dest_quiz_path)){
Let's re-run `check_quizzes()`.
```{r}
-quiz_checklist <- leanbuild::check_quizzes(quiz_dir = "quizzes")
+quiz_checklist <- ottr::check_quizzes(quiz_dir = "quizzes")
```
We have some warning messages about various items and the errors have been saved to `'question_error_report.tsv'` which we can read in and check out.
@@ -216,14 +216,14 @@ Then you can re-run `check_quizzes()` and see if the warning is resolved.
## 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 `leanbuild::bookdown_to_leanpub()` function.
+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 `ottr::bookdown_to_leanpub()` function.
```{r}
# Set up a character string
survey_link <- "Please provide any feedback you have in [this survey](www.some_link.org)"
# Supply the footer text in the main function
-leanbuild::bookdown_to_leanpub(make_book_txt = TRUE,
+ottr::bookdown_to_leanpub(make_book_txt = TRUE,
footer_text = survey_link)
```
@@ -232,7 +232,7 @@ leanbuild::bookdown_to_leanpub(make_book_txt = TRUE,
If you don't want those example files hanging around, we can run this function to cleanup the example files.
```{r, echo = FALSE, results = FALSE}
-leanbuild::example_repo_cleanup(files_to_remove = basename(example_files), verbose = FALSE)
+ottr::example_repo_cleanup(files_to_remove = basename(example_files), verbose = FALSE)
```
Lastly, we will print out the session info.
