Skip to content

Commit

Permalink
differences for PR #27
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 14, 2023
1 parent af11e91 commit b9a53cf
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 19 deletions.
37 changes: 19 additions & 18 deletions introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,7 @@ Our vision for this workshop is to increase the awareness of good practices that

![Our vision: Increase the awareness of good practices that complement an R and Git workflow](fig/goal-intro.png)

## What can we do?

A fair strategy to follow is to gradually incorporate good practices in scientific computing ([Wilson et al. 2017](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1005510)) that include:

- Data management,
- Software development,
- Collaboration,
- Project organization,
- Keep track of changes, and
- Manuscript writing.

But before incorporating any new practice, first, we can evaluate the **processes** we are following. A process-centred approach helps us remove the focus on human error, be aware that processes can fail people with good intentions, and accept that we can enter a continuous improvement cycle.
The figure above helps us to visualize and potentially evaluate the **processes** we are following. A process-centred approach helps us remove the focus on human error, be aware that processes can fail people with good intentions, and accept that we can enter a continuous improvement cycle.

> "By defining the process, we can begin to borrow from the rich field of operations,
which focuses primarily on (the) process. One paradigm that proves especially useful is
Expand Down Expand Up @@ -88,15 +77,17 @@ Share one idea from your neighbour.

::::::::::::::::::::::::::::

## How can we start?

Our plan for this workshop is to prioritize three tools, given their [usefulness once mastered and the time to master them](https://teachtogether.tech/en/index.html#s:motivation-authentic):
## What can we do?

- Use research compendium templates.
- Make reproducible analysis.
- Write informative READMEs.
A fair strategy to follow is to **gradually** incorporate good practices in scientific computing ([Wilson et al. 2017](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1005510)) that include:

We'll relate relevant features for Sustainable software, Reproducible research, and Open science for each tool.
- Data management,
- Software development,
- Collaboration,
- Project organization,
- Keep track of changes, and
- Manuscript writing.

:::testimonial

Expand All @@ -110,6 +101,16 @@ We support the opinion of [Jaime Quinn](https://sorse.github.io/blog/a-reproduci

:::

## How can we start?

Our plan for this workshop is to prioritize three tools, given their [usefulness once mastered and the time to master them](https://teachtogether.tech/en/index.html#s:motivation-authentic):

- Use research compendium templates.
- Make reproducible analysis.
- Write informative READMEs.

We'll relate relevant features for Sustainable software, Reproducible research, and Open science for each tool.

::::::::::::::::::::::::::::::::::::: keypoints

- Our vision is to increase the awareness of tools to improve the reproducibility of data analysis.
Expand Down
2 changes: 1 addition & 1 deletion md5sum.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"index.md" "ca324507113d77941fd0f97f7aae49e6" "site/built/index.md" "2023-12-05"
"links.md" "8184cf4149eafbf03ce8da8ff0778c14" "site/built/links.md" "2023-11-21"
"episodes/beforestart.Rmd" "1c71e52033982952220732b11411c3f3" "site/built/beforestart.md" "2023-11-21"
"episodes/introduction.Rmd" "dfb0171263db444dd8f810067c45171a" "site/built/introduction.md" "2023-12-14"
"episodes/introduction.Rmd" "bf1db0df4ea112e03adad49bedede0f3" "site/built/introduction.md" "2023-12-14"
"episodes/compendium.Rmd" "346914df8e0a0695f4791a7b57718696" "site/built/compendium.md" "2023-11-21"
"episodes/reproducible.Rmd" "11be248121bf6ff3fd7f72c3123107a5" "site/built/reproducible.md" "2023-11-21"
"episodes/readmefile.Rmd" "3cc0212d4220e050446c4ebc49bf83f6" "site/built/readmefile.md" "2023-11-21"
Expand Down

0 comments on commit b9a53cf

Please sign in to comment.