Skip to content

Commit b2dc5f7

Browse files
Render course
1 parent 82d7a3b commit b2dc5f7

9 files changed

+19
-20
lines changed

docs/05-scientific-notebooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ From @Shapiro2021
132132
More reading about RStudio's interface:
133133

134134
- [RStudio IDE Cheatsheet (pdf)](https://rstudio.github.io/cheatsheets/html/rstudio-ide.html).
135-
- [Navigating the RStudio Interface - R for Epidemiology](https://www.r4epi.com/navigating-the-rstudio-interface.html)
135+
- [Navigating the RStudio Interface - R for Epidemiology](https://www.r4epi.com/chapters/navigating_rstudio/navigating_rstudio)
136136

137137
</details>
138138

docs/07-durable-code.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ We'll talk a bit more about code review in an upcoming chapter!
4040

4141
- [Readable Code](https://blog.pragmaticengineer.com/readable-code/) by @Orosz2019.
4242
- [Write clean R code](https://appsilon.com/write-clean-r-code/) by @Dubel2021.
43-
- [Python Clean Code: 6 Best Practices to Make Your Python Functions More Readable](https://towardsdatascience.com/python-clean-code-6-best-practices-to-make-your-python-functions-more-readable-7ea4c6171d60) by @Tran2021.
43+
- [Python Clean Code: 6 Best Practices to Make Your Python Functions More Readable](https://medium.com/data-science/python-clean-code-6-best-practices-to-make-your-python-functions-more-readable-7ea4c6171d60) by @Tran2021.
4444

4545
#### DRY up your code
4646
<img src="resources/images/DRY.png" width="12%">
@@ -185,8 +185,8 @@ Try to avoid using variable names that have no meaning like `tmp` or `x`, or `i`
185185

186186
**More reading:**
187187

188-
- [R for Epidemiology - Coding best Practices](https://www.r4epi.com/coding-best-practices.html#object-variable-names) by @Cannell2021.
189-
- [Data Scientists: Your Variable Names Are Awful. Here’s How to Fix Them](https://towardsdatascience.com/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them-89053d2855be) by @Koehrsen2019.
188+
- [R for Epidemiology - Coding best Practices](https://www.r4epi.com/chapters/best_practices/best_practices#object-variable-names) by @Cannell2021.
189+
- [Data Scientists: Your Variable Names Are Awful. Here’s How to Fix Them](https://willkoehrsen.github.io/data%20science/software%20engineering/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them/) by @Koehrsen2019.
190190
- [Writing Variable — Informative, Descriptive & Elegant](https://medium.datadriveninvestor.com/writing-variable-informative-descriptive-elegant-1dd6f3f15db3) by @Hobert2018.
191191

192192
#### Follow a code style
@@ -308,7 +308,7 @@ There's so many opinions and strategies on best practices for code. And although
308308

309309
- [Data Carpentry's: Best Practices for Writing R Code](https://swcarpentry.github.io/r-novice-inflammation/06-best-practices-R.html) by @DataCarpentry2021b.
310310
- [R Programming for Research: Reproducible Research](https://geanders.github.io/RProgrammingForResearch/reproducible-research-1.html) by @Good2021.
311-
- [R for Epidemiology: Coding best practices](https://www.r4epi.com/coding-best-practices.html) by @Cannell2021.
311+
- [R for Epidemiology: Coding best practices](https://www.r4epi.com/chapters/best_practices/best_practices) by @Cannell2021.
312312
- [Best practices for R Programming](https://towardsdatascience.com/best-practices-for-r-programming-ec0754010b5a) by @Bernardo2021.
313313

314314
## Get the exercise project files (or continue with the files you used in the previous chapter)

docs/08-readmes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ You can take a look at this [template README](https://raw.githubusercontent.com/
5959

6060
- [How to write a good README file](https://www.freecodecamp.org/news/how-to-write-a-good-readme-file/)
6161
- [A Beginners Guide to writing a Kicka** README](https://meakaakka.medium.com/a-beginners-guide-to-writing-a-kickass-readme-7ac01da88ab3)
62-
- [How to write an awesome README](https://towardsdatascience.com/how-to-write-an-awesome-readme-68bf4be91f8b)
62+
- [Tips for Creating Great README Docs](https://www.archbee.com/blog/readme-creating-tips)
6363

6464
## Get the exercise project files (or continue with the files you used in the previous chapter)
6565

37 Bytes
Binary file not shown.

docs/documenting-analyses.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ <h4><span class="header-section-number">8.2.2.1</span> More about writing README
358358
<ul>
359359
<li><a href="https://www.freecodecamp.org/news/how-to-write-a-good-readme-file/">How to write a good README file</a></li>
360360
<li><a href="https://meakaakka.medium.com/a-beginners-guide-to-writing-a-kickass-readme-7ac01da88ab3">A Beginners Guide to writing a Kicka** README</a></li>
361-
<li><a href="https://towardsdatascience.com/how-to-write-an-awesome-readme-68bf4be91f8b">How to write an awesome README</a></li>
361+
<li><a href="https://www.archbee.com/blog/readme-creating-tips">Tips for Creating Great README Docs</a></li>
362362
</ul>
363363
</div>
364364
</div>

docs/references.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ <h1>References<a href="references.html#references" class="anchor-section" aria-l
335335
Bryan, Jenny, and Jim Hester. 2021. <span>“Happy Git and GitHub for the useR.”</span> <a href="https://happygitwithr.com/">https://happygitwithr.com/</a>.
336336
</div>
337337
<div class="csl-entry">
338-
Cannell, Brad. 2021. <em>9 <span>Coding</span> Best Practices <span></span> <span>R</span> for <span>Epidemiology</span></em>. <a href="https://brad-cannell.github.io/r4epi/">https://brad-cannell.github.io/r4epi/</a>.
338+
Cannell, Brad. 2021. <em>9 <span>Coding</span> Best Practices <span></span> <span>R</span> for <span>Epidemiology</span></em>. <a href="https://www.r4epi.com/">https://www.r4epi.com/</a>.
339339
</div>
340340
<div class="csl-entry">
341341
Carrie Wright, Stephanie C. Hicks and Roger D. Peng, Shannon E. Ellis. n.d. <em>Chapter 1 <span>Introduction</span> to the <span>Tidyverse</span> <span></span> <span>Tidyverse</span> <span>Skills</span> for <span>Data</span> <span>Science</span></em>. Accessed November 2, 2021. <a href="http://jhudatascience.org/tidyversecourse/intro.html">http://jhudatascience.org/tidyversecourse/intro.html</a>.
@@ -398,7 +398,7 @@ <h1>References<a href="references.html#references" class="anchor-section" aria-l
398398
Klinefelter, Sarah. 2016. <span><span>DRY</span> <span>Programming</span> <span>Practices</span><span>Metova</span>.”</span> <a href="https://metova.com/dry-programming-practices/">https://metova.com/dry-programming-practices/</a>.
399399
</div>
400400
<div class="csl-entry">
401-
Koehrsen, Will. 2019. <span>“Data <span>Scientists</span>: <span>Your</span> <span>Variable</span> <span>Names</span> <span>Are</span> <span>Awful</span>. <span>Here</span>’s <span>How</span> to <span>Fix</span> <span>Them</span>.”</span> <em>Medium</em>. <a href="https://towardsdatascience.com/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them-89053d2855be">https://towardsdatascience.com/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them-89053d2855be</a>.
401+
Koehrsen, Will. 2019. <span>“Data <span>Scientists</span>: <span>Your</span> <span>Variable</span> <span>Names</span> <span>Are</span> <span>Awful</span>. <span>Here</span>’s <span>How</span> to <span>Fix</span> <span>Them</span>.”</span> <em>Medium</em>. <a href="https://willkoehrsen.github.io/data%20science/software%20engineering/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them/">https://willkoehrsen.github.io/data%20science/software%20engineering/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them/</a>.
402402
</div>
403403
<div class="csl-entry">
404404
Kostyuk, Victor. 2020. <span>“Data <span>Science</span> <span>Python</span> <span>Best</span> <span>Practices</span>.”</span> <em>BCG GAMMA</em>. <a href="https://medium.com/bcggamma/data-science-python-best-practices-fdb16fdedf82">https://medium.com/bcggamma/data-science-python-best-practices-fdb16fdedf82</a>.
@@ -488,7 +488,7 @@ <h1>References<a href="references.html#references" class="anchor-section" aria-l
488488
Team, Smartbear. 2021. <span>“Best <span>Practices</span> for <span>Code</span> <span>Review</span>.”</span> <em>Smartbear.com</em>. <a href="https://smartbear.com/en/learn/code-review/best-practices-for-peer-code-review/">https://smartbear.com/en/learn/code-review/best-practices-for-peer-code-review/</a>.
489489
</div>
490490
<div class="csl-entry">
491-
Tran, Khuyen. 2021. <span>“Python <span>Clean</span> <span>Code</span>: 6 <span>Best</span> <span>Practices</span> to <span>Make</span> Your <span>Python</span> <span>Functions</span> More <span>Readable</span>.”</span> <em>Medium</em>. <a href="https://towardsdatascience.com/python-clean-code-6-best-practices-to-make-your-python-functions-more-readable-7ea4c6171d60">https://towardsdatascience.com/python-clean-code-6-best-practices-to-make-your-python-functions-more-readable-7ea4c6171d60</a>.
491+
Tran, Khuyen. 2021. <span>“Python <span>Clean</span> <span>Code</span>: 6 <span>Best</span> <span>Practices</span> to <span>Make</span> Your <span>Python</span> <span>Functions</span> More <span>Readable</span>.”</span> <em>Medium</em>. <a href="https://medium.com/data-science/python-clean-code-6-best-practices-to-make-your-python-functions-more-readable-7ea4c6171d60">https://medium.com/data-science/python-clean-code-6-best-practices-to-make-your-python-functions-more-readable-7ea4c6171d60</a>.
492492
</div>
493493
<div class="csl-entry">
494494
Wickham, Hadley. 2019. <span>“Style Guide · <span>Advanced</span> <span>R</span>.”</span> <a href="http://adv-r.had.co.nz/Style.html">http://adv-r.had.co.nz/Style.html</a>.

docs/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/using-notebooks.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ <h3><span class="header-section-number">5.3.1</span> Set up your IDE<a href="usi
446446
<p>More reading about RStudio’s interface:</p>
447447
<ul>
448448
<li><a href="https://rstudio.github.io/cheatsheets/html/rstudio-ide.html">RStudio IDE Cheatsheet (pdf)</a>.</li>
449-
<li><a href="https://www.r4epi.com/navigating-the-rstudio-interface.html">Navigating the RStudio Interface - R for Epidemiology</a></li>
449+
<li><a href="https://www.r4epi.com/chapters/navigating_rstudio/navigating_rstudio">Navigating the RStudio Interface - R for Epidemiology</a></li>
450450
</ul>
451451
</details>
452452
</div>

docs/writing-durable-code.html

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ <h4><span class="header-section-number">7.2.0.2</span> Prioritize readability ov
345345
</li>
346346
<li><a href="https://appsilon.com/write-clean-r-code/">Write clean R code</a> by <span class="citation">Dubel (<a href="#ref-Dubel2021">2021</a>)</span>.<br />
347347
</li>
348-
<li><a href="https://towardsdatascience.com/python-clean-code-6-best-practices-to-make-your-python-functions-more-readable-7ea4c6171d60">Python Clean Code: 6 Best Practices to Make Your Python Functions More Readable</a> by <span class="citation">Tran (<a href="#ref-Tran2021">2021</a>)</span>.</li>
348+
<li><a href="https://medium.com/data-science/python-clean-code-6-best-practices-to-make-your-python-functions-more-readable-7ea4c6171d60">Python Clean Code: 6 Best Practices to Make Your Python Functions More Readable</a> by <span class="citation">Tran (<a href="#ref-Tran2021">2021</a>)</span>.</li>
349349
</ul>
350350
</div>
351351
<div id="dry-up-your-code" class="section level4 hasAnchor" number="7.2.0.3">
@@ -467,9 +467,8 @@ <h4><span class="header-section-number">7.2.0.6</span> Use informative variable
467467
<p><span class="citation">(<a href="#ref-Hobert2018">Hobert 2018</a>)</span></p>
468468
<p><strong>More reading:</strong></p>
469469
<ul>
470-
<li><a href="https://www.r4epi.com/coding-best-practices.html#object-variable-names">R for Epidemiology - Coding best Practices</a> by <span class="citation">Cannell (<a href="#ref-Cannell2021">2021</a>)</span>.</li>
471-
<li><a href="https://towardsdatascience.com/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them-89053d2855be">Data Scientists: Your Variable Names Are Awful. Here’s How to Fix Them</a> by <span class="citation">Koehrsen (<a href="#ref-Koehrsen2019">2019</a>)</span>.<br />
472-
</li>
470+
<li><a href="https://www.r4epi.com/chapters/best_practices/best_practices#object-variable-names">R for Epidemiology - Coding best Practices</a> by <span class="citation">Cannell (<a href="#ref-Cannell2021">2021</a>)</span>.</li>
471+
<li><a href="https://willkoehrsen.github.io/data%20science/software%20engineering/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them/">Data Scientists: Your Variable Names Are Awful. Here’s How to Fix Them</a> by <span class="citation">Koehrsen (<a href="#ref-Koehrsen2019">2019</a>)</span>.</li>
473472
<li><a href="https://medium.datadriveninvestor.com/writing-variable-informative-descriptive-elegant-1dd6f3f15db3">Writing Variable — Informative, Descriptive &amp; Elegant</a> by <span class="citation">Hobert (<a href="#ref-Hobert2018">2018</a>)</span>.</li>
474473
</ul>
475474
</div>
@@ -573,7 +572,7 @@ <h4><span class="header-section-number">7.3.0.2</span> R specific:<a href="writi
573572
<ul>
574573
<li><a href="https://swcarpentry.github.io/r-novice-inflammation/06-best-practices-R.html">Data Carpentry’s: Best Practices for Writing R Code</a> by <span class="citation"><span>“Best <span>Practices</span> for <span>Writing</span> <span>R</span> <span>Code</span><span>Programming</span> with <span>R</span></span> (<a href="#ref-DataCarpentry2021b">2021</a>)</span>.</li>
575574
<li><a href="https://geanders.github.io/RProgrammingForResearch/reproducible-research-1.html">R Programming for Research: Reproducible Research</a> by <span class="citation">Good (<a href="#ref-Good2021">2021</a>)</span>.</li>
576-
<li><a href="https://www.r4epi.com/coding-best-practices.html">R for Epidemiology: Coding best practices</a> by <span class="citation">Cannell (<a href="#ref-Cannell2021">2021</a>)</span>.</li>
575+
<li><a href="https://www.r4epi.com/chapters/best_practices/best_practices">R for Epidemiology: Coding best practices</a> by <span class="citation">Cannell (<a href="#ref-Cannell2021">2021</a>)</span>.</li>
577576
<li><a href="https://towardsdatascience.com/best-practices-for-r-programming-ec0754010b5a">Best practices for R Programming</a> by <span class="citation">Bernardo (<a href="#ref-Bernardo2021">2021</a>)</span>.</li>
578577
</ul>
579578
</div>
@@ -868,7 +867,7 @@ <h3>References<a href="references.html#references" class="anchor-section" aria-l
868867
Bryan, Jenny. 2017. <span>“Project-Oriented Workflow.”</span> <em>Tidyverse Blog</em>. <a href="https://www.tidyverse.org/blog/2017/12/workflow-vs-script/">https://www.tidyverse.org/blog/2017/12/workflow-vs-script/</a>.
869868
</div>
870869
<div id="ref-Cannell2021" class="csl-entry">
871-
Cannell, Brad. 2021. <em>9 <span>Coding</span> Best Practices <span></span> <span>R</span> for <span>Epidemiology</span></em>. <a href="https://brad-cannell.github.io/r4epi/">https://brad-cannell.github.io/r4epi/</a>.
870+
Cannell, Brad. 2021. <em>9 <span>Coding</span> Best Practices <span></span> <span>R</span> for <span>Epidemiology</span></em>. <a href="https://www.r4epi.com/">https://www.r4epi.com/</a>.
872871
</div>
873872
<div id="ref-Wright2021" class="csl-entry">
874873
Carrie Wright, Stephanie C. Hicks and Roger D. Peng, Shannon E. Ellis. n.d. <em>Chapter 1 <span>Introduction</span> to the <span>Tidyverse</span> <span></span> <span>Tidyverse</span> <span>Skills</span> for <span>Data</span> <span>Science</span></em>. Accessed November 2, 2021. <a href="http://jhudatascience.org/tidyversecourse/intro.html">http://jhudatascience.org/tidyversecourse/intro.html</a>.
@@ -916,7 +915,7 @@ <h3>References<a href="references.html#references" class="anchor-section" aria-l
916915
Klinefelter, Sarah. 2016. <span><span>DRY</span> <span>Programming</span> <span>Practices</span><span>Metova</span>.”</span> <a href="https://metova.com/dry-programming-practices/">https://metova.com/dry-programming-practices/</a>.
917916
</div>
918917
<div id="ref-Koehrsen2019" class="csl-entry">
919-
Koehrsen, Will. 2019. <span>“Data <span>Scientists</span>: <span>Your</span> <span>Variable</span> <span>Names</span> <span>Are</span> <span>Awful</span>. <span>Here</span>’s <span>How</span> to <span>Fix</span> <span>Them</span>.”</span> <em>Medium</em>. <a href="https://towardsdatascience.com/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them-89053d2855be">https://towardsdatascience.com/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them-89053d2855be</a>.
918+
Koehrsen, Will. 2019. <span>“Data <span>Scientists</span>: <span>Your</span> <span>Variable</span> <span>Names</span> <span>Are</span> <span>Awful</span>. <span>Here</span>’s <span>How</span> to <span>Fix</span> <span>Them</span>.”</span> <em>Medium</em>. <a href="https://willkoehrsen.github.io/data%20science/software%20engineering/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them/">https://willkoehrsen.github.io/data%20science/software%20engineering/data-scientists-your-variable-names-are-awful-heres-how-to-fix-them/</a>.
920919
</div>
921920
<div id="ref-Kostyuk2020" class="csl-entry">
922921
Kostyuk, Victor. 2020. <span>“Data <span>Science</span> <span>Python</span> <span>Best</span> <span>Practices</span>.”</span> <em>BCG GAMMA</em>. <a href="https://medium.com/bcggamma/data-science-python-best-practices-fdb16fdedf82">https://medium.com/bcggamma/data-science-python-best-practices-fdb16fdedf82</a>.
@@ -979,7 +978,7 @@ <h3>References<a href="references.html#references" class="anchor-section" aria-l
979978
Team, Analytics Vidhya. 2019. <span>“What Is <span>Tidyverse</span> <span></span> <span>Tidyverse</span> <span>Package</span> in <span>R</span>.”</span> <em>Analytics Vidhya</em>. <a href="https://www.analyticsvidhya.com/blog/2019/05/beginner-guide-tidyverse-most-powerful-collection-r-packages-data-science/">https://www.analyticsvidhya.com/blog/2019/05/beginner-guide-tidyverse-most-powerful-collection-r-packages-data-science/</a>.
980979
</div>
981980
<div id="ref-Tran2021" class="csl-entry">
982-
Tran, Khuyen. 2021. <span>“Python <span>Clean</span> <span>Code</span>: 6 <span>Best</span> <span>Practices</span> to <span>Make</span> Your <span>Python</span> <span>Functions</span> More <span>Readable</span>.”</span> <em>Medium</em>. <a href="https://towardsdatascience.com/python-clean-code-6-best-practices-to-make-your-python-functions-more-readable-7ea4c6171d60">https://towardsdatascience.com/python-clean-code-6-best-practices-to-make-your-python-functions-more-readable-7ea4c6171d60</a>.
981+
Tran, Khuyen. 2021. <span>“Python <span>Clean</span> <span>Code</span>: 6 <span>Best</span> <span>Practices</span> to <span>Make</span> Your <span>Python</span> <span>Functions</span> More <span>Readable</span>.”</span> <em>Medium</em>. <a href="https://medium.com/data-science/python-clean-code-6-best-practices-to-make-your-python-functions-more-readable-7ea4c6171d60">https://medium.com/data-science/python-clean-code-6-best-practices-to-make-your-python-functions-more-readable-7ea4c6171d60</a>.
983982
</div>
984983
<div id="ref-Wickham" class="csl-entry">
985984
Wickham, Hadley. 2019. <span>“Style Guide · <span>Advanced</span> <span>R</span>.”</span> <a href="http://adv-r.had.co.nz/Style.html">http://adv-r.had.co.nz/Style.html</a>.

0 commit comments

Comments
 (0)