diff --git a/.github/sync.yml b/.github/sync.yml index 83621240..bc05965a 100755 --- a/.github/sync.yml +++ b/.github/sync.yml @@ -37,7 +37,7 @@ group: jhudsl/Machine_Learning_for_Cancer_Informatics jhudsl/Cancer_Informatics_Data_Visualization jhudsl/Cancer_Genome_Informatics - jhudsl/Cancer-Imaging-Informatics + fhdsl/Cancer_Imaging_Informatics datatrail-jhu/DataTrail_Template abyzovlab/CNVpytor-course opencasestudies/OCS_Guide @@ -56,11 +56,13 @@ group: griffithlab/CIVIC_SVI_Course PracticalGenomics/cogaps-on-sciserver fhdsl/AI_for_software + fhdsl/AI_for_Decision_Makers griffithlab/Immuno_Workflow_Course fhdsl/S1_Intro_to_R fhdsl/S1_Intro_to_Command_Line fhdsl/S1_Intro_to_Git_GitHub fhdsl/WDL_Workflows_Guide + fhdsl/S2-Collaborative-Git-GitHub ###ADD NEW REPO HERE following the format above# diff --git a/.github/workflows/delete-preview.yml b/.github/workflows/delete-preview.yml index afd658af..faa83ccd 100644 --- a/.github/workflows/delete-preview.yml +++ b/.github/workflows/delete-preview.yml @@ -18,7 +18,7 @@ jobs: # Check out current repository - name: checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 diff --git a/.github/workflows/docker-build.yml b/.github/workflows/docker-build.yml index 77491cb8..4a169645 100644 --- a/.github/workflows/docker-build.yml +++ b/.github/workflows/docker-build.yml @@ -20,7 +20,7 @@ jobs: steps: - name: checkout repo - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Login as jhudsl-robot run: | diff --git a/.github/workflows/docker-test.yml b/.github/workflows/docker-test.yml index e1eab59c..01cb3845 100644 --- a/.github/workflows/docker-test.yml +++ b/.github/workflows/docker-test.yml @@ -33,10 +33,10 @@ jobs: steps: - name: checkout repo - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Verify Dockerfiles changed? - uses: tj-actions/verify-changed-files@v8.8 + uses: tj-actions/verify-changed-files@v17 id: verify-changed-files with: files: | diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index 99b1bcd4..781c439c 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -14,9 +14,10 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 + token: ${{ secrets.GH_PAT }} # Use the yaml-env-action action. - name: Load environment from YAML @@ -41,6 +42,7 @@ jobs: git push --set-upstream origin $branch_name || echo echo branch exists remotely shell: bash + outputs: toggle_spell_check: "${{ env.SPELL_CHECK }}" toggle_style_code: "${{ env.STYLE_CODE }}" @@ -59,6 +61,7 @@ jobs: check_type: spelling error_min: 3 gh_pat: secrets.GH_PAT + branch_name: ${GITHUB_HEAD_REF} url-check: name: Check URLs @@ -69,6 +72,7 @@ jobs: check_type: urls error_min: 0 gh_pat: secrets.GH_PAT + branch_name: ${GITHUB_HEAD_REF} quiz-check: name: Check quiz formatting @@ -79,6 +83,7 @@ jobs: check_type: quiz_format error_min: 0 gh_pat: secrets.GH_PAT + branch_name: ${GITHUB_HEAD_REF} ############################# Style the code ################################### style-code: @@ -91,7 +96,7 @@ jobs: steps: - name: Checkout files - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 @@ -117,7 +122,7 @@ jobs: steps: - name: Checkout files - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 diff --git a/.github/workflows/render-all.yml b/.github/workflows/render-all.yml index b9b19728..4c1058c3 100644 --- a/.github/workflows/render-all.yml +++ b/.github/workflows/render-all.yml @@ -19,7 +19,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 # Use the yaml-env-action action. - name: Load environment from YAML @@ -44,7 +44,7 @@ jobs: steps: - name: checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 token: ${{ secrets.GH_PAT }} @@ -96,7 +96,7 @@ jobs: steps: - name: checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 token: ${{ secrets.GH_PAT }} @@ -135,7 +135,7 @@ jobs: steps: - name: checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 token: ${{ secrets.GH_PAT }} @@ -211,7 +211,7 @@ jobs: steps: - name: checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 token: ${{ secrets.GH_PAT }} @@ -229,12 +229,16 @@ jobs: run: Rscript -e "ottrpal::convert_coursera_quizzes()" # Commit the rendered bookdown files + # Only commit coursera quizzes if the directory is present - name: Commit rendered Coursera files env: GH_PAT: ${{ secrets.GH_PAT }} run: | git remote set-url origin https://${GH_PAT}@github.com/${GITHUB_REPOSITORY} git fetch origin + if [ -d 'coursera_quizzes' ]; then + git add --force coursera_quizzes/* + fi git add --force manuscript/* git add --force resources/* git add --force docs/* diff --git a/.github/workflows/send-updates.yml b/.github/workflows/send-updates.yml index 3fda2330..07a0cd99 100644 --- a/.github/workflows/send-updates.yml +++ b/.github/workflows/send-updates.yml @@ -18,7 +18,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Login as jhudsl-robot run: | diff --git a/.github/workflows/starting-course.yml b/.github/workflows/starting-course.yml index 5ded0b20..053c3750 100644 --- a/.github/workflows/starting-course.yml +++ b/.github/workflows/starting-course.yml @@ -16,7 +16,7 @@ jobs: if: github.event.repository.name != 'OTTR_Template' steps: - name: checkout repo - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Login as jhudsl-robot run: | diff --git a/.github/workflows/transfer-rendered-files.yml b/.github/workflows/transfer-rendered-files.yml index 3c3577ee..776c7791 100644 --- a/.github/workflows/transfer-rendered-files.yml +++ b/.github/workflows/transfer-rendered-files.yml @@ -21,7 +21,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 # Use the yaml-env-action action. - name: Load environment from YAML @@ -42,22 +42,23 @@ jobs: if: ${{needs.yaml-check.outputs.toggle_coursera == 'yes' || needs.yaml-check.outputs.toggle_leanpub == 'yes'}} steps: + - name: Checkout from Bookdown Repo + uses: actions/checkout@v4 + with: + path: bookdown + token: ${{ secrets.GH_PAT }} + - name: Run git repo check id: git_repo_check env: GH_PAT: ${{ secrets.GH_PAT }} run: | - sudo apt-get install subversion - # What's the Quizzes repository's name? QUIZ_REPO=$(echo ${GITHUB_REPOSITORY} | sed "s/_Bookdown/ /g" | sed "s/_Template/ /g" | awk '{print $1"_Quizzes"}') echo $QUIZ_REPO - # Get repo check script - svn export --force https://github.com/${GITHUB_REPOSITORY}.git/branches/${GITHUB_REF#refs/heads/}/scripts/git_repo_check.R git_repo_check.R - # Run repo check script - results=$(Rscript --vanilla git_repo_check.R --repo "$GITHUB_REPOSITORY" --git_pat "$GH_PAT") + results=$(Rscript --vanilla bookdown/scripts/git_repo_check.R --repo "$GITHUB_REPOSITORY" --git_pat "$GH_PAT") echo $QUIZ_REPO exists: $results echo "git_results=$results" >> $GITHUB_OUTPUT @@ -65,8 +66,9 @@ jobs: - name: Checkout code from Leanpub repo if: ${{ steps.git_repo_check.outputs.git_results == 'TRUE' }} - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: + path: quizzes repository: ${{ steps.git_repo_check.outputs.leanpub_repo }} token: ${{ secrets.GH_PAT }} @@ -76,17 +78,19 @@ jobs: env: GH_PAT: ${{ secrets.GH_PAT }} run: | - # Copy over images folder - svn export --force https://github.com/${GITHUB_REPOSITORY}.git/branches/${GITHUB_REF#refs/heads/}/resources/chapt_screen_images resources/chapt_screen_images - - # Copy over _bookdown.yml - svn export --force https://github.com/${GITHUB_REPOSITORY}.git/branches/${GITHUB_REF#refs/heads/}/_bookdown.yml _bookdown.yml + # Copy over images folder (from bookdown to quizzes repo) + mkdir -p quizzes/resources/chapt_screen_images + cp bookdown/resources/chapt_screen_images/* quizzes/resources/chapt_screen_images + + # Copy over _bookdown.yml (from bookdown to quizzes repo) + cp bookdown/_bookdown.yml quizzes/_bookdown.yml - name: Create PR with resources files if: ${{ steps.git_repo_check.outputs.git_results == 'TRUE' }} uses: peter-evans/create-pull-request@v3 id: cpr with: + path: quizzes # Must create the PR in the Quizzes Repo token: ${{ secrets.GH_PAT }} commit-message: Copy files from Bookdown repository signoff: false diff --git a/02-chapter_of_course.Rmd b/02-chapter_of_course.Rmd index 68835cfd..d35bbe3d 100644 --- a/02-chapter_of_course.Rmd +++ b/02-chapter_of_course.Rmd @@ -98,14 +98,6 @@ knitr::include_url("https://www.youtube.com/embed/VOCYL-FNbr0") -## File examples - -You can again use simple markdown syntax to just include a link to a file like so: - -[A file](https://www.bgsu.edu/content/dam/BGSU/center-for-faculty-excellence/docs/TLGuides/TLGuide-Learning-Objectives.pdf). - -Alternatively you can embed files like PDFs. - ### Using `knitr` ```{r, fig.align="center", echo=FALSE, out.width="100%"} @@ -243,6 +235,15 @@ reflection text +Here is a `
` box: + +
+ +Work in Progress text + +
+ + ## Dropdown summaries
You can hide additional information in a dropdown menu diff --git a/assets/box_images/under_construction.png b/assets/box_images/under_construction.png new file mode 100644 index 00000000..a67bd5c1 Binary files /dev/null and b/assets/box_images/under_construction.png differ diff --git a/assets/style.css b/assets/style.css index 21ed0c65..748acad3 100755 --- a/assets/style.css +++ b/assets/style.css @@ -250,7 +250,7 @@ li.appendix span, li.part span { /* for TOC part names */ /* Sidebar formating --------------------------------------------*/ /* from r-pkgs.org*/ -div.notice, div.warning, div.github, div.dictionary, div.reflection { +div.notice, div.warning, div.github, div.dictionary, div.reflection, div.wip { padding: 1em; margin: 1em 0; padding-left: 100px; @@ -304,6 +304,14 @@ div.reflection{ background-image: url("../assets/box_images/thinking_face.png"); } +div.wip{ + border: 4px #000000; + border-style: solid; + background-size: 70px; + background-position: 15px center; + background-color: #f4d03f; + background-image: url("../assets/box_images/under_construction.png"); +} /* .book .book-body .page-wrapper .page-inner section.normal is needed to override the styles produced by gitbook, which are ridiculously diff --git a/docs/01-intro.md b/docs/01-intro.md index b90fd117..fa13828a 100644 --- a/docs/01-intro.md +++ b/docs/01-intro.md @@ -32,7 +32,7 @@ devtools::session_info() ## collate en_US.UTF-8 ## ctype en_US.UTF-8 ## tz Etc/UTC -## date 2023-05-24 +## date 2024-01-16 ## ## ─ Packages ─────────────────────────────────────────────────────────────────── ## package * version date lib source diff --git a/docs/02-chapter_of_course.md b/docs/02-chapter_of_course.md index ed07ebaf..25fe4eae 100644 --- a/docs/02-chapter_of_course.md +++ b/docs/02-chapter_of_course.md @@ -130,14 +130,6 @@ Note that you should use `echo=FALSE` in the code chunk because we don't want th -## File examples - -You can again use simple markdown syntax to just include a link to a file like so: - -[A file](https://www.bgsu.edu/content/dam/BGSU/center-for-faculty-excellence/docs/TLGuides/TLGuide-Learning-Objectives.pdf). - -Alternatively you can embed files like PDFs. - ### Using `knitr` @@ -271,6 +263,15 @@ reflection text
+Here is a `
` box: + +
+ +Work in Progress text + +
+ + ## Dropdown summaries
You can hide additional information in a dropdown menu @@ -297,7 +298,7 @@ devtools::session_info() ## collate en_US.UTF-8 ## ctype en_US.UTF-8 ## tz Etc/UTC -## date 2023-05-24 +## date 2024-01-16 ## ## ─ Packages ─────────────────────────────────────────────────────────────────── ## package * version date lib source diff --git a/docs/404.html b/docs/404.html index f4131773..9d37d4a4 100644 --- a/docs/404.html +++ b/docs/404.html @@ -180,25 +180,22 @@ -
  • 2.7 File examples +
  • 2.7 Website Examples
  • -
  • 2.8 Website Examples +
  • 2.8 Citation examples
  • +
  • 2.9 Stylized boxes
  • -
  • 2.9 Citation examples
  • -
  • 2.10 Stylized boxes -
  • -
  • 2.11 Dropdown summaries
  • -
  • 2.12 Print out session info
  • +
  • 2.10 Dropdown summaries
  • +
  • 2.11 Print out session info
  • About the Authors
  • 3 References
  • diff --git a/docs/About.md b/docs/About.md index 105ef319..13ae4849 100644 --- a/docs/About.md +++ b/docs/About.md @@ -51,7 +51,7 @@ These credits are based on our [course contributors table guidelines](https://ww ## collate en_US.UTF-8 ## ctype en_US.UTF-8 ## tz Etc/UTC -## date 2023-05-24 +## date 2024-01-16 ## ## ─ Packages ─────────────────────────────────────────────────────────────────── ## package * version date lib source diff --git a/docs/Course_Name.docx b/docs/Course_Name.docx index d2270b54..895d6221 100644 Binary files a/docs/Course_Name.docx and b/docs/Course_Name.docx differ diff --git a/docs/a-new-chapter.html b/docs/a-new-chapter.html index d42b3f13..88947b0e 100644 --- a/docs/a-new-chapter.html +++ b/docs/a-new-chapter.html @@ -180,25 +180,22 @@ -
  • 2.7 File examples +
  • 2.7 Website Examples
  • -
  • 2.8 Website Examples +
  • 2.8 Citation examples
  • +
  • 2.9 Stylized boxes
  • -
  • 2.9 Citation examples
  • -
  • 2.10 Stylized boxes -
  • -
  • 2.11 Dropdown summaries
  • -
  • 2.12 Print out session info
  • +
  • 2.10 Dropdown summaries
  • +
  • 2.11 Print out session info
  • About the Authors
  • 3 References
  • @@ -325,57 +322,51 @@

    2.6.2 Using HTML

    - -
    -

    2.7 File examples

    -

    You can again use simple markdown syntax to just include a link to a file like so:

    -

    A file.

    -

    Alternatively you can embed files like PDFs.

    -
    -

    2.7.1 Using knitr

    +
    +

    2.6.3 Using knitr

    -
    -

    2.7.2 Using HTML

    +
    +

    2.6.4 Using HTML

    -
    -

    2.8 Website Examples

    +
    +

    2.7 Website Examples

    Yet again you can use a link to a website like so:

    A Website

    You might want to have users open a website in a new tab by default, especially if they need to reference both the course and a resource at once.

    A Website

    Or, you can embed some websites.

    -
    -

    2.8.1 Using knitr

    +
    +

    2.7.1 Using knitr

    This works:

    -
    -

    2.8.2 Using HTML

    +
    +

    2.7.2 Using HTML

    If you’d like the URL to show up in a new tab you can do this:

    <a href="https://www.linkedin.com" target="_blank">LinkedIn</a>
    -
    -

    2.9 Citation examples

    +
    +

    2.8 Citation examples

    We can put citations at the end of a sentence like this (Allaire et al. 2021). Or multiple citations Xie, Allaire, and Grolemund (2018).

    but they need a ; separator (Allaire et al. 2021; Xie, Allaire, and Grolemund 2018).

    In text, we can put citations like this Allaire et al. (2021).

    -
    -

    2.10 Stylized boxes

    +
    +

    2.9 Stylized boxes

    Occasionally, you might find it useful to emphasize a particular piece of information. To help you do so, we have provided css code and images (no need for you to worry about that!) to create the following stylized boxes.

    You can use these boxes in your course with either of two options: using HTML code or Pandoc syntax.

    -
    -

    2.10.1 Using rmarkdown container syntax

    +
    +

    2.9.1 Using rmarkdown container syntax

    The rmarkdown package allows for a different syntax to be converted to the HTML that you just saw and also allows for conversion to LaTeX. See the Bookdown documentation for more information (Xie, Dervieux, and Riederer 2020). Note that Bookdown uses Pandoc.

    ::: {.notice}
     Note using rmarkdown syntax.
    @@ -392,8 +383,8 @@ 

    2.10.1 Using rmarkdownsee more)

    -
    -

    2.10.2 Using HTML

    +
    +

    2.9.2 Using HTML

    To add a warning box like the following use:

    <div class = "notice">
     Followed by the text you want inside
    @@ -418,10 +409,14 @@ 

    2.10.2 Using HTML

    reflection text

    +

    Here is a <div class = "wip"> box:

    +
    +

    Work in Progress text

    +
    -