You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/07-durable-code.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ We'll talk a bit more about code review in an upcoming chapter!
40
40
41
41
-[Readable Code](https://blog.pragmaticengineer.com/readable-code/) by @Orosz2019.
42
42
-[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.
44
44
45
45
#### DRY up your code
46
46
<imgsrc="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`
185
185
186
186
**More reading:**
187
187
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.
190
190
-[Writing Variable — Informative, Descriptive & Elegant](https://medium.datadriveninvestor.com/writing-variable-informative-descriptive-elegant-1dd6f3f15db3) by @Hobert2018.
191
191
192
192
#### Follow a code style
@@ -308,7 +308,7 @@ There's so many opinions and strategies on best practices for code. And although
308
308
309
309
-[Data Carpentry's: Best Practices for Writing R Code](https://swcarpentry.github.io/r-novice-inflammation/06-best-practices-R.html) by @DataCarpentry2021b.
310
310
-[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.
312
312
-[Best practices for R Programming](https://towardsdatascience.com/best-practices-for-r-programming-ec0754010b5a) by @Bernardo2021.
313
313
314
314
## Get the exercise project files (or continue with the files you used in the previous chapter)
Copy file name to clipboardExpand all lines: docs/documenting-analyses.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -358,7 +358,7 @@ <h4><span class="header-section-number">8.2.2.1</span> More about writing README
358
358
<ul>
359
359
<li><ahref="https://www.freecodecamp.org/news/how-to-write-a-good-readme-file/">How to write a good README file</a></li>
360
360
<li><ahref="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><ahref="https://towardsdatascience.com/how-to-write-an-awesome-readme-68bf4be91f8b">How to write an awesome README</a></li>
361
+
<li><ahref="https://www.archbee.com/blog/readme-creating-tips">Tips for Creating Great README Docs</a></li>
Bryan, Jenny, and Jim Hester. 2021. <span>“Happy Git and GitHub for the useR.”</span><ahref="https://happygitwithr.com/">https://happygitwithr.com/</a>.
336
336
</div>
337
337
<divclass="csl-entry">
338
-
Cannell, Brad. 2021. <em>9 <span>Coding</span> Best Practices <span></span><span>R</span> for <span>Epidemiology</span></em>. <ahref="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>. <ahref="https://www.r4epi.com/">https://www.r4epi.com/</a>.
339
339
</div>
340
340
<divclass="csl-entry">
341
341
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. <ahref="http://jhudatascience.org/tidyversecourse/intro.html">http://jhudatascience.org/tidyversecourse/intro.html</a>.
Team, Smartbear. 2021. <span>“Best <span>Practices</span> for <span>Code</span><span>Review</span>.”</span><em>Smartbear.com</em>. <ahref="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>.
489
489
</div>
490
490
<divclass="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>. <ahref="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>. <ahref="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>.
Copy file name to clipboardExpand all lines: docs/writing-durable-code.html
+7-8Lines changed: 7 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -345,7 +345,7 @@ <h4><span class="header-section-number">7.2.0.2</span> Prioritize readability ov
345
345
</li>
346
346
<li><ahref="https://appsilon.com/write-clean-r-code/">Write clean R code</a> by <spanclass="citation">Dubel (<ahref="#ref-Dubel2021">2021</a>)</span>.<br/>
347
347
</li>
348
-
<li><ahref="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 <spanclass="citation">Tran (<ahref="#ref-Tran2021">2021</a>)</span>.</li>
348
+
<li><ahref="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 <spanclass="citation">Tran (<ahref="#ref-Tran2021">2021</a>)</span>.</li>
<li><ahref="https://www.r4epi.com/coding-best-practices.html#object-variable-names">R for Epidemiology - Coding best Practices</a> by <spanclass="citation">Cannell (<ahref="#ref-Cannell2021">2021</a>)</span>.</li>
471
-
<li><ahref="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 <spanclass="citation">Koehrsen (<ahref="#ref-Koehrsen2019">2019</a>)</span>.<br/>
472
-
</li>
470
+
<li><ahref="https://www.r4epi.com/chapters/best_practices/best_practices#object-variable-names">R for Epidemiology - Coding best Practices</a> by <spanclass="citation">Cannell (<ahref="#ref-Cannell2021">2021</a>)</span>.</li>
471
+
<li><ahref="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 <spanclass="citation">Koehrsen (<ahref="#ref-Koehrsen2019">2019</a>)</span>.</li>
473
472
<li><ahref="https://medium.datadriveninvestor.com/writing-variable-informative-descriptive-elegant-1dd6f3f15db3">Writing Variable — Informative, Descriptive & Elegant</a> by <spanclass="citation">Hobert (<ahref="#ref-Hobert2018">2018</a>)</span>.</li>
474
473
</ul>
475
474
</div>
@@ -573,7 +572,7 @@ <h4><span class="header-section-number">7.3.0.2</span> R specific:<a href="writi
573
572
<ul>
574
573
<li><ahref="https://swcarpentry.github.io/r-novice-inflammation/06-best-practices-R.html">Data Carpentry’s: Best Practices for Writing R Code</a> by <spanclass="citation"><span>“Best <span>Practices</span> for <span>Writing</span><span>R</span><span>Code</span> – <span>Programming</span> with <span>R</span>”</span> (<ahref="#ref-DataCarpentry2021b">2021</a>)</span>.</li>
575
574
<li><ahref="https://geanders.github.io/RProgrammingForResearch/reproducible-research-1.html">R Programming for Research: Reproducible Research</a> by <spanclass="citation">Good (<ahref="#ref-Good2021">2021</a>)</span>.</li>
576
-
<li><ahref="https://www.r4epi.com/coding-best-practices.html">R for Epidemiology: Coding best practices</a> by <spanclass="citation">Cannell (<ahref="#ref-Cannell2021">2021</a>)</span>.</li>
575
+
<li><ahref="https://www.r4epi.com/chapters/best_practices/best_practices">R for Epidemiology: Coding best practices</a> by <spanclass="citation">Cannell (<ahref="#ref-Cannell2021">2021</a>)</span>.</li>
577
576
<li><ahref="https://towardsdatascience.com/best-practices-for-r-programming-ec0754010b5a">Best practices for R Programming</a> by <spanclass="citation">Bernardo (<ahref="#ref-Bernardo2021">2021</a>)</span>.</li>
Cannell, Brad. 2021. <em>9 <span>Coding</span> Best Practices <span></span><span>R</span> for <span>Epidemiology</span></em>. <ahref="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>. <ahref="https://www.r4epi.com/">https://www.r4epi.com/</a>.
872
871
</div>
873
872
<divid="ref-Wright2021" class="csl-entry">
874
873
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. <ahref="http://jhudatascience.org/tidyversecourse/intro.html">http://jhudatascience.org/tidyversecourse/intro.html</a>.
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>. <ahref="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>.
980
979
</div>
981
980
<divid="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>. <ahref="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>. <ahref="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>.
0 commit comments