Skip to content

Commit

Permalink
edit introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
ahasverus committed Sep 30, 2024
1 parent 8dce271 commit 43ceb9c
Show file tree
Hide file tree
Showing 6 changed files with 131 additions and 153 deletions.
Binary file added images/peng-science.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/reproducible-matrix.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 2 additions & 8 deletions index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,10 @@ engine: knitr
```


<!-- Insert section 'Table of contents' -->
<!-- Insert section 'Main content' -->

```{r}
#| child: "sections/table-of-contents.qmd"
#| child: "sections/main-content.qmd"
```


<!-- Insert section 'Quarto basics' -->

```{r}
#| child: "sections/quarto-basics.qmd"
```

129 changes: 129 additions & 0 deletions sections/main-content.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
## What is reproducibility?

<br>

![Source: [https://eliocamp.github.io](https://eliocamp.github.io/reproducibility-with-r/materials/day1/01-introduction/)](images/reproducible-matrix.jpg){fig-align="center" width="50%"}


**Reproducibility** is about results that can be obtained by someone else (or you in the future) given the **same data** and the **same code**. This is a technical problem.

<br/>

{{< fa hand-point-right >}} &nbsp;We talk about **Computational reproducibility**


## Why does it matter?


> An **article** about computational results is advertising, not scholarship. The actual scholarship is the full **software environment**, **code** and **data**, that produced the result.
::: {.citation}
Claerbout & Karrenbach (1992)[^claerbout]
:::

<br/>


[^claerbout]: <https://doi.org/10.1190/1.1822162>


## Why does it matter?


> An **article** about computational results is advertising, not scholarship. The actual scholarship is the full **software environment**, **code** and **data**, that produced the result.
::: {.citation}
Claerbout & Karrenbach (1992)[^claerbout]
:::

<br/>

> Reproducibility has the potential to serve as a minimum standard for **judging scientific claims** (...).
::: {.citation}
Peng (2011)[^peng]
:::


[^peng]: <https://doi.org/10.1126/science.1213847>


## Why does it matter?


> An **article** about computational results is advertising, not scholarship. The actual scholarship is the full **software environment**, **code** and **data**, that produced the result.
::: {.citation}
Claerbout & Karrenbach (1992)[^claerbout]
:::

<br/>

> Reproducibility has the potential to serve as a minimum standard for **judging scientific claims** (...).
::: {.citation}
Peng (2011)[^peng]
:::

<br/>

{{< fa hand-point-right >}} &nbsp;Sharing the code and the data is now a prerequisite for publishing in many journals



## Reproducibility spectrum

<br>

![Source: Peng (2011)[^peng]](images/peng-science.jpg){fig-align="center" width="75%"}

. . .

<br/>

Each degree of reproducibility requires additional skills and time. While some of those skills (e.g. literal programming, version control, setting up environments) pay off in the long run, they can require a high up-front investment.


## Concepts

According to Wilson _et al._ (2017)[^wilson], good practices for a better reproducibility can be organized into the following six topics:

<br/>
<br/>
<br/>

:::: { .columns }
::: { .column .center width="33%"}
{{< fa database >}} &nbsp;Data management
:::
::: { .column .center width="33%"}
{{< fa folder >}} &nbsp;Project organization
:::
::: { .column .center width="33%"}
{{< fa code-branch >}} &nbsp;Tracking changes
:::
::::

<br/>

:::: { .columns }
::: { .column .center width="33%"}
{{< fa brands github >}} &nbsp;Collaboration
:::
::: { .column .center width="33%"}
{{< fa brands markdown >}} &nbsp;Manuscript
:::
::: { .column .center width="33%"}
{{< fa brands r-project >}} &nbsp;Code & Software
:::
::::


[^wilson]: <https://doi.org/10.1371/journal.pcbi.1005510>



## Tools

Coming soon...

111 changes: 0 additions & 111 deletions sections/quarto-basics.qmd

This file was deleted.

34 changes: 0 additions & 34 deletions sections/table-of-contents.qmd

This file was deleted.

0 comments on commit 43ceb9c

Please sign in to comment.