Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ottr -> ottrpal #472

Merged
merged 3 commits into from
Feb 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/automatic-issues/images-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ See [Setting Up Images and Graphics](https://github.com/jhudsl/OTTR_Template/wik
- [ ] The color palette choices of the slide are contrasted in a way that is friendly to those with color vision deficiencies.
You can check this using [Color Oracle](https://colororacle.org/).

- [ ] Every image is [inserted into the text](https://github.com/jhudsl/OTTR_Template/wiki/Setting-up-images-and-graphics#adding-images-and-graphics-in-text) using one of these options: `ottr::include_slide()`, `knitr::include_image()`, or this format: `<img src="blah.png" alt="SOMETHING">`.
- [ ] Every image is [inserted into the text](https://github.com/jhudsl/OTTR_Template/wiki/Setting-up-images-and-graphics#adding-images-and-graphics-in-text) using one of these options: `ottrpal::include_slide()`, `knitr::include_image()`, or this format: `<img src="blah.png" alt="SOMETHING">`.

- [ ] Every image has [alternative text added to it](https://github.com/jhudsl/OTTR_Template/wiki/Setting-up-images-and-graphics#adding-images-and-graphics-in-text).

- [ ] The beginning of each Rmd contains this chunk so the images are saved in the correct spot:

`````
```{r, include = FALSE}
ottr::set_knitr_image_path()
ottrpal::set_knitr_image_path()
```
`````
2 changes: 1 addition & 1 deletion .github/automatic-issues/update-enrollment.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ We are working on adding more features and smoothing out bugs as we go.

If you want to receive updates from the original template to your course template, you will need to enroll this repository to the template updates by adding it to the `sync.yml` file.

- [ ] [Follow these instructions](https://github.com/jhudsl/OTTR_Template/wiki/Start-a-new-course#10-enroll-your-repository-for-ottr-updates) to enroll your course repository to receive these updates.
- [ ] [Follow these instructions](https://github.com/jhudsl/OTTR_Template/wiki/Start-a-new-course#10-enroll-your-repository-for-ottrpal-updates) to enroll your course repository to receive these updates.

- [ ] [Ensure that you have followed these instructions](https://github.com/jhudsl/OTTR_Template/wiki/Start-a-new-course#5-add-jhudsl-robot-as-a-collaborator) to add the `jhudsl-robot` as a collaborator to your repository.
4 changes: 2 additions & 2 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ jobs:
- name: Run quiz check
id: quiz_check_run
run: |
Rscript -e "ottr::check_quizzes(quiz_dir = 'quizzes', write_report = TRUE, verbose = TRUE)"
Rscript -e "ottrpal::check_quizzes(quiz_dir = 'quizzes', write_report = TRUE, verbose = TRUE)"
results=0
if -f "question_error_report.tsv"; then
results=$(wc -l < question_error_report.tsv >/dev/null)
Expand Down Expand Up @@ -344,7 +344,7 @@ jobs:
# This job creates a shared scaffold for both.
- name: Run TOC-less version of render
id: tocless
run: Rscript -e "ottr::render_without_toc()"
run: Rscript -e "ottrpal::render_without_toc()"

# This checks on the steps before it and makes sure that they completed.
# If the renders didn't complete we don't want to commit the file changes
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/render-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ jobs:
# This job creates a shared scaffold for both.
- name: Run TOC-less version of render
id: tocless
run: Rscript -e "ottr::render_without_toc()"
run: Rscript -e "ottrpal::render_without_toc()"

# Commit the TOC-less version files
- name: Commit tocless bookdown files
Expand All @@ -118,7 +118,7 @@ jobs:
needs: [yaml-check, render-tocless]
runs-on: ubuntu-latest
container:
image: jhudsl/ottr
image: jhudsl/ottrpal:main
if: ${{needs.yaml-check.outputs.toggle_leanpub == 'yes'}}

steps:
Expand All @@ -144,9 +144,9 @@ jobs:
- name: Delete old manuscript/
run: rm -rf manuscript/

- name: Run ottr::bookdown_to_embed_leanpub
- name: Run ottrpal::bookdown_to_embed_leanpub
run: |
Rscript -e "ottr::bookdown_to_embed_leanpub(
Rscript -e "ottrpal::bookdown_to_embed_leanpub(
render = FALSE, \
chapt_img_key = 'resources/chapt_screen_images/chapter_urls.tsv', \
make_book_txt = TRUE)"
Expand Down Expand Up @@ -184,7 +184,7 @@ jobs:
- name: Convert Leanpub quizzes to Coursera
if: needs.yaml-check.outputs.toggle_leanpub == 'yes'
id: coursera
run: Rscript -e "ottr::convert_coursera_quizzes()"
run: Rscript -e "ottrpal::convert_coursera_quizzes()"

# Commit the rendered bookdown files
- name: Commit rendered Coursera files
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/transfer-rendered-files.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,11 @@ jobs:
signoff: false
branch: auto_copy_rendered_files
delete-branch: true
title: 'GHA: Automated transfer of ottr-needed files from Bookdown repository'
title: 'GHA: Automated transfer of ottrpal-needed files from Bookdown repository'
body: |
### Description:
This PR was initiated by transfer-rendered.yml in the Bookdown repository.
It copies over the ottr-needed folder (for the `bookdown_to_embed_leanpub(render = FALSE)` function
It copies over the ottrpal-needed folder (for the `bookdown_to_embed_leanpub(render = FALSE)` function
to run properly.
- resources/chapt_screen_images/*
labels: |
Expand Down
2 changes: 1 addition & 1 deletion 01-intro.Rmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

```{r, include = FALSE}
ottr::set_knitr_image_path()
ottrpal::set_knitr_image_path()
```

# Introduction
Expand Down
10 changes: 6 additions & 4 deletions 02-chapter_of_course.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@
Every chapter needs to start out with this chunk of code:

```{r, include = FALSE}
ottr::set_knitr_image_path()
ottrpal::set_knitr_image_path()
```

blah
blah blah
qwerty
## Learning Objectives

*Every chapter also needs Learning objectives that will look like this:
Expand Down Expand Up @@ -63,10 +65,10 @@ dev.off()

### Image example

How to include a Google slide. It's simplest to use the `ottr` package:
How to include a Google slide. It's simplest to use the `ottrpal` package:

```{r, fig.align='center', echo = FALSE, fig.alt= "Major point!! example image"}
ottr::include_slide("https://docs.google.com/presentation/d/1YmwKdIy9BeQ3EShgZhvtb3MgR8P6iDX4DfFD65W_gdQ/edit#slide=id.gcc4fbee202_0_141")
ottrpal::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:
Expand Down
4 changes: 2 additions & 2 deletions About.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ These credits are based on our [course contributors table guidelines](https://gi
|Template Publishing Engineers|[Candace Savonen], [Carrie Wright]|
|Publishing Maintenance Engineer|[Candace Savonen]|
|Technical Publishing Stylists|[Carrie Wright], [Candace Savonen]|
|Package Developers ([ottr])|[John Muschelli], [Candace Savonen], [Carrie Wright]|
|Package Developers ([ottrpal])|[John Muschelli], [Candace Savonen], [Carrie Wright]|
|**Art and Design**||
|Illustrator(s)| Created graphics for the course|
|Figure Artist(s)| Created figures/plots for course|
Expand All @@ -52,7 +52,7 @@ devtools::session_info()

<!-- Links -->

[ottr]: https://github.com/jhudsl/ottr
[ottrpal]: https://github.com/jhudsl/ottrpal

<!-- Fill out this table using these instructions: https://github.com/jhudsl/OTTR_Template/wiki/How-to-give-credits

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ _This template and guide helps you_:
- [Bookdown](https://bookdown.org/)
- [Coursera](https://www.coursera.org/)
- Have [Github action robots](https://github.com/jhudsl/OTTR_Template/wiki/How-to-set-up-and-customize-GitHub-actions-robots) do your repetitive tasks like spell check and re-rendering.
- Use [automagic conversion](https://github.com/jhudsl/ottr) to ease the lift of prepping the material for different platforms' formats.
- Use [automagic conversion](https://github.com/jhudsl/ottrpal) to ease the lift of prepping the material for different platforms' formats.
- Use [our Docker image](https://hub.docker.com/repository/docker/jhudsl/course_template) for consistency across authors as well as to help you [avoid dependency hell](https://en.wikipedia.org/wiki/Dependency_hell).

<img src="https://docs.google.com/presentation/d/18k_QN7l6zqZQXoiRfKWzcYFXNXJJEo6j4daYGoc3UcU/export/png?id=18k_QN7l6zqZQXoiRfKWzcYFXNXJJEo6j4daYGoc3UcU&pageid=gf4fcf6569c_2_29" width="500"/>
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docker/github_package_list.tsv
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ yihui/xfun 74c2a6605d8f0fb19314da542baeead6dc8697d9
yihui/knitr a1052d12e0ff8f4ead365b4c85ef5835faa1c492
r-lib/rlang f0c9be5c5806b4e4b120b7516f286fef3c66bda5
jhudsl/didactr cde4598c10f2b5e2e31b47fe94ca1b02db420e10
jhudsl/ottr HEAD
jhudsl/ottrpal HEAD
tidyverse/rvest 4fe39fb5089512d77b6a9cc026e5c895258ff6ce
R-lib/testthat e99155af85261e065192feb946dcfa6679cffae4
rstudio/bookdown 88bc4ead8562ea281838041c795b38fc4a6a7165
Expand Down
2 changes: 1 addition & 1 deletion docker/install_github.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ option_list <- list(
default = "github_package_list.tsv" ,
help = "Path to a TSV with a list of packages to be installed through Github,
where file where the first column is the github package name e.g.
jhudsl/ottr and the second column is the commit ID to be installed
jhudsl/ottrpal and the second column is the commit ID to be installed
(to be supplied to the ref argument).
",
metavar = "character"
Expand Down
4 changes: 2 additions & 2 deletions docs/02-chapter_of_course.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ dev.off()

### Image example

How to include a Google slide. It's simplest to use the `ottr` package:
How to include a Google slide. It's simplest to use the `ottrpal` package:

![](resources/images/02-chapter_of_course_files/figure-docx//1YmwKdIy9BeQ3EShgZhvtb3MgR8P6iDX4DfFD65W_gdQ_gcc4fbee202_0_141.png)

Expand Down Expand Up @@ -228,7 +228,7 @@ devtools::session_info()
## lifecycle 1.0.0 2021-02-15 [1] CRAN (R 4.0.2)
## magrittr * 2.0.2 2022-01-26 [1] CRAN (R 4.0.2)
## memoise 1.1.0 2017-04-21 [1] RSPM (R 4.0.0)
## ottr 0.1.2 2022-02-11 [1] Github (jhudsl/ottr@2d03822)
## ottrpal 0.1.2 2022-02-11 [1] Github (jhudsl/ottrpal@2d03822)
## pillar 1.4.6 2020-07-10 [1] RSPM (R 4.0.2)
## pkgbuild 1.1.0 2020-07-13 [1] RSPM (R 4.0.2)
## pkgconfig 2.0.3 2019-09-22 [1] RSPM (R 4.0.3)
Expand Down
4 changes: 2 additions & 2 deletions docs/About.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ These credits are based on our [course contributors table guidelines](https://gi
|Template Publishing Engineers|[Candace Savonen], [Carrie Wright]|
|Publishing Maintenance Engineer|[Candace Savonen]|
|Technical Publishing Stylists|[Carrie Wright], [Candace Savonen]|
|Package Developers ([ottr])|[John Muschelli], [Candace Savonen], [Carrie Wright]|
|Package Developers ([ottrpal])|[John Muschelli], [Candace Savonen], [Carrie Wright]|
|**Art and Design**||
|Illustrator(s)| Created graphics for the course|
|Figure Artist(s)| Created figures/plots for course|
Expand Down Expand Up @@ -106,7 +106,7 @@ These credits are based on our [course contributors table guidelines](https://gi

<!-- Links -->

[ottr]: https://github.com/jhudsl/ottr
[ottrpal]: https://github.com/jhudsl/ottrpal

<!-- Fill out this table using these instructions: https://github.com/jhudsl/OTTR_Template/wiki/How-to-give-credits

Expand Down
2 changes: 1 addition & 1 deletion docs/about-the-authors.html
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ <h1>About the Authors</h1>
<td><a href="https://carriewright11.github.io/">Carrie Wright</a>, <a href="https://www.cansavvy.com/">Candace Savonen</a></td>
</tr>
<tr class="even">
<td>Package Developers (<a href="https://github.com/jhudsl/ottr">ottr</a>)</td>
<td>Package Developers (<a href="https://github.com/jhudsl/ottrpal">ottrpal</a>)</td>
<td><a href="https://johnmuschelli.com/">John Muschelli</a>, <a href="https://www.cansavvy.com/">Candace Savonen</a>, <a href="https://carriewright11.github.io/">Carrie Wright</a></td>
</tr>
<tr class="odd">
Expand Down
4 changes: 2 additions & 2 deletions docs/coursera/02-chapter_of_course.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ dev.off()

### Image example

How to include a Google slide. It's simplest to use the `ottr` package:
How to include a Google slide. It's simplest to use the `ottrpal` package:

<img src="resources/images/02-chapter_of_course_files/figure-html//1YmwKdIy9BeQ3EShgZhvtb3MgR8P6iDX4DfFD65W_gdQ_gcc4fbee202_0_141.png" title="Major point!! example image" alt="Major point!! example image" style="display: block; margin: auto;" />

Expand Down Expand Up @@ -225,7 +225,7 @@ devtools::session_info()
## lifecycle 1.0.0 2021-02-15 [1] CRAN (R 4.0.2)
## magrittr * 1.5 2014-11-22 [1] RSPM (R 4.0.0)
## memoise 1.1.0 2017-04-21 [1] RSPM (R 4.0.0)
## ottr 0.1.2 2022-02-08 [1] Github (jhudsl/ottr@0c1f578)
## ottrpal 0.1.2 2022-02-08 [1] Github (jhudsl/ottrpal@0c1f578)
## pillar 1.4.6 2020-07-10 [1] RSPM (R 4.0.2)
## pkgbuild 1.1.0 2020-07-13 [1] RSPM (R 4.0.2)
## pkgconfig 2.0.3 2019-09-22 [1] RSPM (R 4.0.3)
Expand Down
6 changes: 3 additions & 3 deletions docs/coursera/About.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ These credits are based on our [course contributors table guidelines](https://gi
|Template Publishing Engineers|[Candace Savonen], [Carrie Wright]|
|Publishing Maintenance Engineer|[Candace Savonen]|
|Technical Publishing Stylists|[Carrie Wright], [Candace Savonen]|
|Package Developers ([ottr])|[John Muschelli], [Candace Savonen], [Carrie Wright]|
|Package Developers ([ottrpal])|[John Muschelli], [Candace Savonen], [Carrie Wright]|
|**Art and Design**||
|Illustrator(s)| Created graphics for the course|
|Figure Artist(s)| Created figures/plots for course|
Expand Down Expand Up @@ -76,7 +76,7 @@ These credits are based on our [course contributors table guidelines](https://gi
## lifecycle 1.0.0 2021-02-15 [1] CRAN (R 4.0.2)
## magrittr 1.5 2014-11-22 [1] RSPM (R 4.0.0)
## memoise 1.1.0 2017-04-21 [1] RSPM (R 4.0.0)
## ottr 0.1.2 2022-02-08 [1] Github (jhudsl/ottr@0c1f578)
## ottrpal 0.1.2 2022-02-08 [1] Github (jhudsl/ottrpal@0c1f578)
## pillar 1.4.6 2020-07-10 [1] RSPM (R 4.0.2)
## pkgbuild 1.1.0 2020-07-13 [1] RSPM (R 4.0.2)
## pkgconfig 2.0.3 2019-09-22 [1] RSPM (R 4.0.3)
Expand Down Expand Up @@ -115,7 +115,7 @@ These credits are based on our [course contributors table guidelines](https://gi

<!-- Links -->

[ottr]: https://github.com/jhudsl/ottr
[ottrpal]: https://github.com/jhudsl/ottrpal

<!-- Fill out this table using these instructions: https://github.com/jhudsl/OTTR_Template/wiki/How-to-give-credits

Expand Down
4 changes: 2 additions & 2 deletions docs/coursera/about-the-authors.html
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ <h1>About the Authors</h1>
<td><a href="https://carriewright11.github.io/">Carrie Wright</a>, <a href="https://www.cansavvy.com/">Candace Savonen</a></td>
</tr>
<tr class="even">
<td>Package Developers (<a href="https://github.com/jhudsl/ottr">ottr</a>)</td>
<td>Package Developers (<a href="https://github.com/jhudsl/ottrpal">ottrpal</a>)</td>
<td><a href="https://johnmuschelli.com/">John Muschelli</a>, <a href="https://www.cansavvy.com/">Candace Savonen</a>, <a href="https://carriewright11.github.io/">Carrie Wright</a></td>
</tr>
<tr class="odd">
Expand Down Expand Up @@ -385,7 +385,7 @@ <h1>About the Authors</h1>
## lifecycle 1.0.0 2021-02-15 [1] CRAN (R 4.0.2)
## magrittr 1.5 2014-11-22 [1] RSPM (R 4.0.0)
## memoise 1.1.0 2017-04-21 [1] RSPM (R 4.0.0)
## ottr 0.1.2 2022-02-08 [1] Github (jhudsl/ottr@0c1f578)
## ottrpal 0.1.2 2022-02-08 [1] Github (jhudsl/ottrpal@0c1f578)
## pillar 1.4.6 2020-07-10 [1] RSPM (R 4.0.2)
## pkgbuild 1.1.0 2020-07-13 [1] RSPM (R 4.0.2)
## pkgconfig 2.0.3 2019-09-22 [1] RSPM (R 4.0.3)
Expand Down
Loading