Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
74 commits
Select commit Hold shift + click to select a range
feedc1f
see if one slide renders yet
kweav Jun 9, 2025
a1d05f1
give it another reference
kweav Jun 9, 2025
50e2c25
handle spell check
kweav Jun 9, 2025
8fdcd71
trying to see if the last line is why a url is being flagged
kweav Jun 9, 2025
a8764f7
link course table
kweav Jun 9, 2025
b60e870
Update 02-setting-up.Rmd
kweav Jun 11, 2025
1d68207
reword and rearrange some
kweav Jun 12, 2025
fc22f8b
resolving marked conflict
kweav Jun 12, 2025
093ff24
header level fix
kweav Jun 12, 2025
e95ff89
modify to create and changes in 3 so far
kweav Jun 12, 2025
7f6853d
adjust thresholds
kweav Jun 12, 2025
dfe06e1
Update pull_request.yml
kweav Jun 13, 2025
78dab21
slide fix for objectives
kweav Jun 16, 2025
64f5cde
Merge branch 'ki_edits' of https://github.com/fhdsl/reproducibility_c…
kweav Jun 16, 2025
0d7588e
put in quotes for render
kweav Jun 16, 2025
9365b62
Update pull_request.yml
kweav Jun 16, 2025
679fb33
moved slide into different deck
kweav Jun 16, 2025
a5b3b1e
.github/workflows/pull_request.yml
kweav Jun 16, 2025
1090d69
add figures about iterative process
kweav Jun 16, 2025
5441792
no echo
kweav Jun 16, 2025
301b021
add more slides and exposition
kweav Jun 16, 2025
b16a53c
renumber a heading
kweav Jun 16, 2025
7309153
Update .github/workflows/pull_request.yml
kweav Jun 23, 2025
cd30a21
does this look how i want
kweav Jun 23, 2025
924e196
test out branch for ava
kweav Jun 23, 2025
6382f00
Merge branch 'ki_edits' into stylize
kweav Jun 23, 2025
f74a504
retrigger render
kweav Jun 23, 2025
0b20efa
Merge branch 'stylize' of https://github.com/fhdsl/reproducibility_ca…
kweav Jun 23, 2025
4922ecd
some quick fixes from the preview
kweav Jun 23, 2025
042f37b
tabset fix maybe
kweav Jun 23, 2025
ed630e3
removing other css code from OTTR_styles.css
carriewright11 Jun 23, 2025
e408807
try details instead of tabset
kweav Jun 24, 2025
879afa6
Merge branch 'stylize' of https://github.com/fhdsl/reproducibility_ca…
kweav Jun 24, 2025
b40b538
fixing links to be white in buttons and updaating to only one style doc
carriewright11 Jun 24, 2025
a772ae5
update dictionary
kweav Jun 24, 2025
f71d350
update to a link
kweav Jun 24, 2025
ac55d10
fix click to expand
kweav Jun 24, 2025
1bc2c32
02-setting-up.Rmd
kweav Jun 24, 2025
ea2e272
recheck background and tabs
kweav Jun 24, 2025
9b3e634
dot instead of dash
kweav Jun 24, 2025
7d872e6
switch to no toc link
kweav Jun 24, 2025
f3fe2ac
how is styling looking
kweav Jun 24, 2025
9e9bc89
try to get nbsp invisible for indented bullet
kweav Jun 24, 2025
8b5839b
new words flagged
kweav Jun 24, 2025
c87544d
oh there was no semicolon
kweav Jun 24, 2025
ca7f708
toc depth
kweav Jun 25, 2025
ce123bb
start rerrange
kweav Jun 25, 2025
6573663
dashes to dots
kweav Jun 25, 2025
8d5c322
stylize and move some content to parallelize
kweav Jun 25, 2025
c05e012
some changes after looking at preview
kweav Jun 25, 2025
049c346
secret content and style
kweav Jun 25, 2025
140fadf
Merge branch 'stylize' into rearrange
kweav Jun 25, 2025
0626b57
fix some more style
kweav Jun 25, 2025
850c25f
Merge branch 'stylize' into rearrange
kweav Jun 25, 2025
dd63d7e
rearrange within chapters
kweav Jun 25, 2025
b67e58e
more assignment rearrangement
kweav Jun 25, 2025
83a7972
address spell check
kweav Jun 25, 2025
5b65cea
Merge branch 'stylize' into rearrange
kweav Jun 25, 2025
7b9ec64
add self a couple of places in author area and update ottrpal link
kweav Jun 25, 2025
44865a8
add some content publishing
kweav Jun 25, 2025
a9f97d0
changes in review with Carrie
kweav Jun 25, 2025
67c48e9
Merge pull request #16 from fhdsl/rearrange
kweav Jun 25, 2025
93ce41f
Update 05-secret-storage.Rmd with iteration slide
kweav Jun 25, 2025
c36ded6
Update 05-secret-storage.Rmd
kweav Jun 25, 2025
64f76c2
Update 05-secret-storage.Rmd
kweav Jun 25, 2025
16d9f82
reflect file name changes
kweav Jun 26, 2025
c1b1d8a
remove assignment numbers
kweav Jun 26, 2025
a2205fe
Merge pull request #15 from fhdsl/stylize
kweav Jun 26, 2025
5e2d3a3
update title
kweav Jun 26, 2025
3211caa
add coursera quiz info for setting up
kweav Jun 26, 2025
16b9d82
Merge branch 'main' into ki_edits
kweav Jun 26, 2025
a4f4464
fix url being flagged that should be ignored
kweav Jun 26, 2025
29f4408
Merge branch 'ki_edits' of https://github.com/fhdsl/reproducibility_c…
kweav Jun 26, 2025
87ec2ce
fix step numbering
kweav Jun 26, 2025
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
5 changes: 2 additions & 3 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
name: Pull Request

on:
pull_request:
branches: [ main, staging ]
pull_request

jobs:

Expand Down Expand Up @@ -146,7 +145,7 @@ jobs:
fetch-depth: 0

- name: Run render
uses: ottrproject/ottr-preview@main
uses: ottrproject/ottr-preview@ah-boolean
with:
toggle_website: ${{needs.yaml-check.outputs.toggle_website}}
docker_image: ${{needs.yaml-check.outputs.rendering_docker_image}}
37 changes: 27 additions & 10 deletions 01-intro.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,37 +18,54 @@ ottrpal::include_slide("https://docs.google.com/presentation/d/1ExTZsKDHKM0fIi0_

The course is intended for cancer researchers, bioinformaticians, and data scientists who work with computational analyses in cancer research contexts and want to enhance the reproducibility, efficiency, and shareability of their work.

This capstone course builds on foundational concepts from the ITCR Training Network's [Reproducibility in Cancer Informatics](https://jhudatascience.org/Reproducibility_in_Cancer_Informatics/introduction.html), [Advanced Reproducibility in Cancer Informatics](https://jhudatascience.org/Adv_Reproducibility_in_Cancer_Informatics/introduction.html), [Containers for Scientists](https://hutchdatascience.org/Containers_for_Scientists/), and [GitHub Automation for Scientists](https://hutchdatascience.org/GitHub_Automation_for_Scientists/) courses. Students should be comfortable with basic GitHub operations, including creating repositories, making commits, and opening pull requests before beginning this capstone.


```{r prereqs, out.width="100%", fig.alt = "Prior to using this capstone, students should be comfortable with basic GitHub operations such as creating repositories or opening pull requests. Students may need to review the I T N courses on reproducibility practices and tools: Reproducibility in cancer informatics, Advanced reproducibility in cancer informatics, GitHub automation for scientists, and containers for scientists.", echo = FALSE, fig.link = "https://www.itcrtraining.org/courses"}
ottrpal::include_slide("https://docs.google.com/presentation/d/1ExTZsKDHKM0fIi0_tB80qd8cHvqjEDyNJp-OsnvZ19o/edit?slide=id.g366a6ed3497_0_211#slide=id.g366a6ed3497_0_211")
```

_This capstone course is written for individuals who:_

- This capstone course builds on foundational concepts from the ITCR Training Network's Reproducibility Series (see list below)
Conduct computational analyses for cancer research, including genomics, proteomics, imaging, or clinical data analysis
- Want to put the reproducibility skill sets together and get more practice in doing this in a “real world” setting.
- Conduct computational analyses for cancer research, including genomics, proteomics, imaging, or clinical data analysis.
- Have completed the ITN reproducibility courses mentioned above
- Want to put the reproducibility skill sets together and get more practice in doing this in a “real world” setting.


```{r, out.width = "100%", fig.alt = "For individuals who: Have completed the Intro Reproducibility, Advanced Reproducibility, Containers for Scientists, and GitHub Automation course in this series. Want to put the reproducibility skill sets together and get more practice in doing this in a real world setting.", echo = FALSE}
```{r for_individuals_who, out.width = "100%", fig.alt = "For individuals who: Have completed the Intro Reproducibility, Advanced Reproducibility, Containers for Scientists, and GitHub Automation course in this series. Want to put the reproducibility skill sets together and get more practice in doing this in a real world setting.", echo = FALSE}
ottrpal::include_slide("https://docs.google.com/presentation/d/1ExTZsKDHKM0fIi0_tB80qd8cHvqjEDyNJp-OsnvZ19o/edit?slide=id.g30a4c584926_0_5#slide=id.g30a4c584926_0_5")
```

This capstone course builds on foundational concepts from the ITCR Training Network's [Reproducibility in Cancer Informatics](https://jhudatascience.org/Reproducibility_in_Cancer_Informatics/introduction.html), [Advanced Reproducibility in Cancer Informatics](https://jhudatascience.org/Adv_Reproducibility_in_Cancer_Informatics/introduction.html), [Containers for Scientists](https://hutchdatascience.org/Containers_for_Scientists/), and [GitHub Automation for Scientists](https://hutchdatascience.org/GitHub_Automation_for_Scientists/) courses. Students should be comfortable with basic GitHub operations, including creating repositories, making commits, and opening pull requests before beginning this capstone.


## Curriculum

The course covers practical application of containerization and automation technologies specifically tailored for cancer informatics workflows. Unlike introductory courses that focus on individual concepts, this capstone emphasizes integration and real-world application of multiple technologies working together.


```{r, out.width = "100%", fig.alt = "This course will demonstrate how to:
Recap the best practices of reproducibility we have covered in this specialization. Create an original docker image. Create an original GitHub Action. Have your original docker image and github action work together", echo = FALSE}
```{r topics_covered, out.width = "100%", fig.alt = "Topics covered in the reproducibility capstone include a review of best practices when using reproducibility tools as well as hands-on real-world practice creating images and containers with docker, automation with GitHub actions, using images and automation together, and creating GitHub secrets to enable use of these reproducbility practices within a GitHub environment", echo = FALSE}
ottrpal::include_slide("https://docs.google.com/presentation/d/1ExTZsKDHKM0fIi0_tB80qd8cHvqjEDyNJp-OsnvZ19o/edit?slide=id.g366a6ed3497_0_0#slide=id.g366a6ed3497_0_0")
```

## Objectives

```{r learning_objectives, out.width = "100%", fig.alt = "This course will demonstrate how to: Review the best practices of reproducibility we have covered in this specialization. Create an original docker image. Create a GitHub secret. Create an original GitHub Action. Have your original docker image and github action work together", echo = FALSE}
ottrpal::include_slide("https://docs.google.com/presentation/d/1ExTZsKDHKM0fIi0_tB80qd8cHvqjEDyNJp-OsnvZ19o/edit?slide=id.g30a4c584926_0_0#slide=id.g30a4c584926_0_0")
```

**Assessment Approach:**

The capstone uses a practical, project-based assessment model where students work with a provided computational sandbox environment to complete real-world tasks. Rather than traditional exams, students demonstrate mastery by successfully implementing containerized workflows and automated pipelines that pass automated evaluation criteria.

**Assignment 1: Custom Container Development** - Students modify and extend Docker containers to support specific cancer analysis requirements, demonstrating understanding of containerization principles and bioinformatics software management.
```{r out.width = "100%", echo=FALSE, fig.alt = "This capstone course has multiple hands-on assignments that are provided in Github repository sandbox"}
ottrpal::include_slide("https://docs.google.com/presentation/d/1ExTZsKDHKM0fIi0_tB80qd8cHvqjEDyNJp-OsnvZ19o/edit?slide=id.g368818bb4f3_0_162#slide=id.g368818bb4f3_0_162")
```

**Custom Container Development Assignment** - Students create Docker containers to support specific cancer analysis requirements, demonstrating understanding of containerization principles and bioinformatics software management.

**Working with GitHub Secrets Assignment** -- Students create a personal access token, store the token as a GitHub secret in a repository and access that secret in a GitHub Actions workflow, displaying application of best practices in security when handling sensitive information.

**Assignment 2: Automated Workflow Implementation** - Students create GitHub Actions that automatically execute and validate cancer data analysis pipelines, showing proficiency in continuous integration concepts and workflow automation.
**Automated Workflow Implementation Assignment** - Students create GitHub Actions that automatically execute and validate cancer data analysis pipelines, showing proficiency in continuous integration concepts and workflow automation.

Each assignment utilizes automated evaluation systems that provide immediate feedback and validation codes upon successful completion, simulating real-world development environments where code must pass automated testing before deployment.

Expand All @@ -71,4 +88,4 @@ Each assignment builds on previous work and integrates multiple technologies. St
**Real-world Application:**
Throughout the course, students are encouraged to consider how the techniques they're learning apply to their own research contexts. The assignments use cancer informatics examples, but the principles and technologies transfer to a wide range of computational research domains.

We also recommend that students leverage the broader ITCR Training Network community and resources, including the [GitHub repository discussions](https://www.itcrtraining.org/), course forums, and peer collaboration opportunities to enhance their learning experience and build lasting professional connections in the cancer informatics community.
We also recommend that students leverage the [broader ITCR Training Network community and resources](https://www.itcrtraining.org/) to enhance their learning experience and build lasting professional connections in the cancer informatics community.
Loading