Skip to content

Commit

Permalink
minor update
Browse files Browse the repository at this point in the history
  • Loading branch information
mjrolland committed Jun 8, 2024
1 parent 1d4d8bc commit 4ff9e98
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 17 deletions.
15 changes: 7 additions & 8 deletions cheatsheet.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ <h1 class="title">Reproducible Research in R (and friends)</h1>
</header>


<p>Reproducibility basics + other helpful tips</p>
<p>Reproducibility basics + a few other helpful tips</p>
<section id="project-organization" class="level2" data-number="1">
<h2 data-number="1" class="anchored" data-anchor-id="project-organization"><span class="header-section-number">1</span> Project Organization</h2>
<ul>
Expand Down Expand Up @@ -159,7 +159,7 @@ <h2 data-number="3" class="anchored" data-anchor-id="data-management"><span clas
<li>Use scripts to clean and process data, save the cleaned data in <code>data/processed/</code></li>
<li>Document each step of data cleaning</li>
<li>Keep data cleaning separate from analysis</li>
<li>Organize your data in a tidy format where each variable is a column, each observation is a row, and each type of observational unit forms a table</li>
<li>Organize your data in a tidy format: each variable is a column, each observation is a row</li>
<li>Reference:
<ul>
<li><a href="https://www.jstatsoft.org/article/view/v059i10">Principles of tidy data</a></li>
Expand Down Expand Up @@ -202,7 +202,8 @@ <h2 data-number="6" class="anchored" data-anchor-id="workflow-automation"><span
<li><p>Use Makefile or <code>targets</code> package to automate and document the workflow</p></li>
<li><p>Reference:</p>
<ul>
<li><a href="https://books.ropensci.org/targets/">Targets Package</a></li>
<li><a href="https://books.ropensci.org/targets/">{targets} Package</a><br>
</li>
<li><a href="https://mjrolland.github.io/ed-neuro-hpa/">Example Project using {targets}</a></li>
</ul></li>
</ul>
Expand All @@ -211,14 +212,12 @@ <h2 data-number="6" class="anchored" data-anchor-id="workflow-automation"><span
<h2 data-number="7" class="anchored" data-anchor-id="analysis-scripts"><span class="header-section-number">7</span> Analysis Scripts</h2>
<ul>
<li>Break analysis into small, reusable functions</li>
<li>Use meaningful and consistent naming conventions</li>
<li>Style your code according to standardized recommendations</li>
<li>Use meaningful and consistent naming conventions such as provided by the <a href="https://style.tidyverse.org/syntax.html#object-names">Tidyverse Naming Conventions</a> for variables and functions and by <a href="https://datacarpentry.org/rr-organization1/01-file-naming/index.html">data carpentry</a> for folders and files</li>
<li>Style your code according to standardized recommendations from the <a href="https://style.tidyverse.org/">Tidyverse Style Guide</a></li>
<li>Reference:
<ul>
<li><a href="https://style.tidyverse.org/">Tidyverse Style Guide</a></li>
<li><a href="https://style.tidyverse.org/syntax.html#object-names">Tidyverse Naming Conventions</a></li>
<li><a href="https://datacarpentry.org/rr-organization1/01-file-naming/index.html">File Naming Conventions</a></li>
<li><a href="https://tidyverse.tidyverse.org/articles/manifesto.html#embrace-functional-programming">Embrace functional programming</a></li>
<li><a href="https://style.tidyverse.org/">Tidyverse Style Guide</a></li>
</ul></li>
</ul>
</section>
Expand Down
16 changes: 7 additions & 9 deletions cheatsheet.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ toc: true
number-sections: true
---

Reproducibility basics + other helpful tips
Reproducibility basics + a few other helpful tips

## Project Organization

Expand Down Expand Up @@ -41,7 +41,7 @@ Reproducibility basics + other helpful tips
- Use scripts to clean and process data, save the cleaned data in `data/processed/`
- Document each step of data cleaning
- Keep data cleaning separate from analysis
- Organize your data in a tidy format where each variable is a column, each observation is a row, and each type of observational unit forms a table
- Organize your data in a tidy format: each variable is a column, each observation is a row
- Reference:
- [Principles of tidy data](https://www.jstatsoft.org/article/view/v059i10)

Expand Down Expand Up @@ -72,19 +72,17 @@ OR
- Use Makefile or `targets` package to automate and document the workflow

- Reference:
- [Targets Package](https://books.ropensci.org/targets/)
- [Example Project using {targets}](https://mjrolland.github.io/ed-neuro-hpa/)
- [{targets} Package](https://books.ropensci.org/targets/)
- [Example Project using {targets}](https://mjrolland.github.io/ed-neuro-hpa/)

## Analysis Scripts

- Break analysis into small, reusable functions
- Use meaningful and consistent naming conventions
- Style your code according to standardized recommendations
- Use meaningful and consistent naming conventions such as provided by the [Tidyverse Naming Conventions](https://style.tidyverse.org/syntax.html#object-names) for variables and functions and by [data carpentry](https://datacarpentry.org/rr-organization1/01-file-naming/index.html) for folders and files
- Style your code according to standardized recommendations from the [Tidyverse Style Guide](https://style.tidyverse.org/)
- Reference:
- [Tidyverse Style Guide](https://style.tidyverse.org/)
- [Tidyverse Naming Conventions](https://style.tidyverse.org/syntax.html#object-names)
- [File Naming Conventions](https://datacarpentry.org/rr-organization1/01-file-naming/index.html)
- [Embrace functional programming](https://tidyverse.tidyverse.org/articles/manifesto.html#embrace-functional-programming)
- [Tidyverse Style Guide](https://style.tidyverse.org/)

## Computational reproducibility

Expand Down

0 comments on commit 4ff9e98

Please sign in to comment.