Skip to content

Commit

Permalink
small updates to week 4 slides
Browse files Browse the repository at this point in the history
  • Loading branch information
samanthacsik committed Oct 24, 2024
1 parent 1889747 commit 75054e0
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 29 deletions.
17 changes: 11 additions & 6 deletions course-materials/materials/blogging-tips.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -824,7 +824,7 @@ countdown::countdown(

```{r}
countdown::countdown(
minutes = 2,
minutes = 3,
# right = 0,
# Fanfare when it's over
play_sound = TRUE,
Expand Down Expand Up @@ -957,7 +957,7 @@ Use metaphors to improve connections or visualizations for your audience. And be
:::: {.columns}

::: {.column width="50%"}
>*"Re stability, vanilla R has changed little over time. Code written a couple of decades ago has a high chance of running now and will (likely) be executable for a long time into the future6. As a result, I contend that R is a horseshoe crab (unchanged for aeons, cryptically beautiful)."*
>*"Re stability, vanilla R has changed little over time. Code written a couple of decades ago has a high chance of running now and will (likely) be executable for a long time into the future. As a result, I contend that R is a horseshoe crab (unchanged for aeons, cryptically beautiful)."*
:::

::: {.column width="50%"}
Expand Down Expand Up @@ -999,7 +999,7 @@ Both quotes and [xkcd adaptation](https://xkcd.com/2347/) come from the section

```{r}
countdown::countdown(
minutes = 6,
minutes = 10,
# right = 0,
# Fanfare when it's over
play_sound = TRUE,
Expand Down Expand Up @@ -1112,9 +1112,14 @@ Your data science blog posts will often include example code. Thoughtfully set y

<br>

- do you need to show messages / warnings to demonstrate your point? if not, suppress them (`message: false` & `warning: false`)
- do you need to show the output of your code or *just* the code? (`eval: false` & `echo: true`)
- do you need to show the code or *just* the output? (`eval: true` & `echo: true`; defaults)
- do you need to show messages / warnings to demonstrate your point? if not, suppress them: `message: false` & `warning: false`
- show just the code, but not the output (e.g. loading libraries): `eval: false` & `echo: true`
- show just the output (and not code): `eval: true` & `echo: false`
<!-- - permit code folding (`code-fold: true` or `code-fold: show`; also [`code-tools: true`](https://quarto.org/docs/output-formats/html-code.html#code-tools)) -->

::: {.footer}
Remember, you can set options in your blog post's YAML or on a chunk-by-chunk basis.
:::

---

Expand Down
25 changes: 14 additions & 11 deletions docs/course-materials/materials/blogging-tips.html
Original file line number Diff line number Diff line change
Expand Up @@ -654,7 +654,7 @@ <h2></h2>
<p><span class="body-text-m"><strong><em>I’ll reset the timer when you and your partner should switch roles!</em></strong></span></p>
<div class="cell">
<div class="cell-output-display">
<div class="countdown" id="timer_0327874d" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown" id="timer_261f25fa" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown-controls"><button class="countdown-bump-down"></button><button class="countdown-bump-up">+</button></div>
<code class="countdown-time"><span class="countdown-digits minutes">04</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
Expand Down Expand Up @@ -830,7 +830,7 @@ <h2></h2>
</div>
<div class="cell">
<div class="cell-output-display">
<div class="countdown" id="timer_1ce05c45" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown" id="timer_efd7feca" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown-controls"><button class="countdown-bump-down"></button><button class="countdown-bump-up">+</button></div>
<code class="countdown-time"><span class="countdown-digits minutes">02</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
Expand Down Expand Up @@ -877,7 +877,7 @@ <h2></h2>
</ul>
<div class="cell">
<div class="cell-output-display">
<div class="countdown" id="timer_582032e1" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown" id="timer_206ae5a1" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown-controls"><button class="countdown-bump-down"></button><button class="countdown-bump-up">+</button></div>
<code class="countdown-time"><span class="countdown-digits minutes">06</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
Expand Down Expand Up @@ -909,9 +909,9 @@ <h2></h2>
<p><span class="body-text-m"><strong><em>I’ll reset the timer when you and your partner should switch roles!</em></strong></span></p>
<div class="cell">
<div class="cell-output-display">
<div class="countdown" id="timer_818fdc57" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown" id="timer_776c145f" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown-controls"><button class="countdown-bump-down"></button><button class="countdown-bump-up">+</button></div>
<code class="countdown-time"><span class="countdown-digits minutes">02</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
<code class="countdown-time"><span class="countdown-digits minutes">03</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
</div>
</div>
Expand Down Expand Up @@ -999,7 +999,7 @@ <h2></h2>
<div class="columns">
<div class="column" style="width:50%;">
<blockquote>
<p><em>“Re stability, vanilla R has changed little over time. Code written a couple of decades ago has a high chance of running now and will (likely) be executable for a long time into the future6. As a result, I contend that R is a horseshoe crab (unchanged for aeons, cryptically beautiful).”</em></p>
<p><em>“Re stability, vanilla R has changed little over time. Code written a couple of decades ago has a high chance of running now and will (likely) be executable for a long time into the future. As a result, I contend that R is a horseshoe crab (unchanged for aeons, cryptically beautiful).”</em></p>
</blockquote>
</div><div class="column" style="width:50%;">
<blockquote>
Expand Down Expand Up @@ -1034,9 +1034,9 @@ <h2></h2>
</ul>
<div class="cell">
<div class="cell-output-display">
<div class="countdown" id="timer_60dbc70a" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown" id="timer_a73e7c22" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown-controls"><button class="countdown-bump-down"></button><button class="countdown-bump-up">+</button></div>
<code class="countdown-time"><span class="countdown-digits minutes">06</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
<code class="countdown-time"><span class="countdown-digits minutes">10</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
</div>
</div>
Expand Down Expand Up @@ -1104,10 +1104,13 @@ <h2></h2>
<p>Your data science blog posts will often include example code. Thoughtfully set your code chunk options so that your examples are easy to follow, but don’t bog down your post by requiring readers to scroll past loonnngggg data frames or messages / warnings (unless there’s an important and demonstrative reason to do so). Consider:</p>
<p><br></p>
<ul>
<li>do you need to show messages / warnings to demonstrate your point? if not, suppress them (<code>message: false</code> &amp; <code>warning: false</code>)</li>
<li>do you need to show the output of your code or <em>just</em> the code? (<code>eval: false</code> &amp; <code>echo: true</code>)</li>
<li>do you need to show the code or <em>just</em> the output? (<code>eval: true</code> &amp; <code>echo: true</code>; defaults)</li>
<li>do you need to show messages / warnings to demonstrate your point? if not, suppress them: <code>message: false</code> &amp; <code>warning: false</code></li>
<li>show just the code, but not the output (e.g.&nbsp;loading libraries): <code>eval: false</code> &amp; <code>echo: true</code></li>
<li>show just the output (and not code): <code>eval: true</code> &amp; <code>echo: false</code> <!-- - permit code folding (`code-fold: true` or `code-fold: show`; also [`code-tools: true`](https://quarto.org/docs/output-formats/html-code.html#code-tools)) --></li>
</ul>
<div class="footer">
<p>Remember, you can set options in your blog post’s YAML or on a chunk-by-chunk basis.</p>
</div>
</section>
<section id="consider-code" class="slide level2" data-menu-title="Consider code">
<h2></h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/course-materials/materials/github-tools.html
Original file line number Diff line number Diff line change
Expand Up @@ -812,7 +812,7 @@ <h2></h2>
</div>
<div class="cell">
<div class="cell-output-display">
<div class="countdown" id="timer_89ec96b9" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown" id="timer_6527b12f" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown-controls"><button class="countdown-bump-down"></button><button class="countdown-bump-up">+</button></div>
<code class="countdown-time"><span class="countdown-digits minutes">05</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
Expand Down
14 changes: 7 additions & 7 deletions docs/course-materials/materials/readme-guidelines-slides.html
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,7 @@ <h2></h2>
</div>
<div class="cell">
<div class="cell-output-display">
<div class="countdown" id="timer_c971176f" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown" id="timer_73e3aae5" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown-controls"><button class="countdown-bump-down"></button><button class="countdown-bump-up">+</button></div>
<code class="countdown-time"><span class="countdown-digits minutes">01</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
Expand All @@ -468,7 +468,7 @@ <h2></h2>
</div>
<div class="cell">
<div class="cell-output-display">
<div class="countdown" id="timer_53312619" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown" id="timer_fe1ffe24" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown-controls"><button class="countdown-bump-down"></button><button class="countdown-bump-up">+</button></div>
<code class="countdown-time"><span class="countdown-digits minutes">03</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
Expand Down Expand Up @@ -503,7 +503,7 @@ <h2></h2>
</div>
<div class="cell">
<div class="cell-output-display">
<div class="countdown" id="timer_73736ade" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown" id="timer_9e8d7b73" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown-controls"><button class="countdown-bump-down"></button><button class="countdown-bump-up">+</button></div>
<code class="countdown-time"><span class="countdown-digits minutes">04</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
Expand All @@ -530,7 +530,7 @@ <h2></h2>
</div>
<div class="cell">
<div class="cell-output-display">
<div class="countdown" id="timer_b9794923" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown" id="timer_a0c0b825" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown-controls"><button class="countdown-bump-down"></button><button class="countdown-bump-up">+</button></div>
<code class="countdown-time"><span class="countdown-digits minutes">03</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
Expand All @@ -557,7 +557,7 @@ <h2></h2>
</div>
<div class="cell">
<div class="cell-output-display">
<div class="countdown" id="timer_33fd7e3b" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown" id="timer_b1fabaf9" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown-controls"><button class="countdown-bump-down"></button><button class="countdown-bump-up">+</button></div>
<code class="countdown-time"><span class="countdown-digits minutes">02</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
Expand All @@ -584,7 +584,7 @@ <h2></h2>
</div>
<div class="cell">
<div class="cell-output-display">
<div class="countdown" id="timer_fe9e90cc" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown" id="timer_c55b59f0" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown-controls"><button class="countdown-bump-down"></button><button class="countdown-bump-up">+</button></div>
<code class="countdown-time"><span class="countdown-digits minutes">02</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
Expand Down Expand Up @@ -683,7 +683,7 @@ <h2></h2>
</div>
<div class="cell">
<div class="cell-output-display">
<div class="countdown" id="timer_48d9eaae" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown" id="timer_d9db9e58" data-update-every="1" data-play-sound="true" tabindex="0" style="right:0;bottom:0;font-size:2em;">
<div class="countdown-controls"><button class="countdown-bump-down"></button><button class="countdown-bump-up">+</button></div>
<code class="countdown-time"><span class="countdown-digits minutes">05</span><span class="countdown-digits colon">:</span><span class="countdown-digits seconds">00</span></code>
</div>
Expand Down
8 changes: 4 additions & 4 deletions docs/search.json
Original file line number Diff line number Diff line change
Expand Up @@ -837,7 +837,7 @@
"href": "course-materials/materials/blogging-tips.html#share-your-story",
"title": "EDS 296",
"section": "",
"text": "YOUR TURN - share\n\n \nShare your outlined story with your partner.\n\n\n\nI’ll reset the timer when you and your partner should switch roles!\n\n\n\n−+\n02:00"
"text": "YOUR TURN - share\n\n \nShare your outlined story with your partner.\n\n\n\nI’ll reset the timer when you and your partner should switch roles!\n\n\n\n−+\n03:00"
},
{
"objectID": "course-materials/materials/blogging-tips.html#add-embellishments-start",
Expand Down Expand Up @@ -872,14 +872,14 @@
"href": "course-materials/materials/blogging-tips.html#metaphors-media",
"title": "EDS 296",
"section": "",
"text": "3/4. Metaphors & Supporting media\n\nUse metaphors to improve connections or visualizations for your audience. And because blog posts are a versatile medium, don’t shy away from including media that helps to demonstrate examples (and importantly, gives your readers a break from a wall of text and code).\n\n\n\n“Re stability, vanilla R has changed little over time. Code written a couple of decades ago has a high chance of running now and will (likely) be executable for a long time into the future6. As a result, I contend that R is a horseshoe crab (unchanged for aeons, cryptically beautiful).”\n\n\n\n“Note that base R is the literal, unyielding base of the teetering tower of packages used by your project (incredible metaphor).”\n\n\n\n\n\n\n\n\n\n\n\n\nBoth quotes and xkcd adaptation come from the section titled, Content. Find many more metaphors and media throughout the blog post."
"text": "3/4. Metaphors & Supporting media\n\nUse metaphors to improve connections or visualizations for your audience. And because blog posts are a versatile medium, don’t shy away from including media that helps to demonstrate examples (and importantly, gives your readers a break from a wall of text and code).\n\n\n\n“Re stability, vanilla R has changed little over time. Code written a couple of decades ago has a high chance of running now and will (likely) be executable for a long time into the future. As a result, I contend that R is a horseshoe crab (unchanged for aeons, cryptically beautiful).”\n\n\n\n“Note that base R is the literal, unyielding base of the teetering tower of packages used by your project (incredible metaphor).”\n\n\n\n\n\n\n\n\n\n\n\n\nBoth quotes and xkcd adaptation come from the section titled, Content. Find many more metaphors and media throughout the blog post."
},
{
"objectID": "course-materials/materials/blogging-tips.html#discuss-embellishments",
"href": "course-materials/materials/blogging-tips.html#discuss-embellishments",
"title": "EDS 296",
"section": "",
"text": "YOUR TURN\n\n\nDiscuss with your partner some ways to add embellishments to both of your stories. Consider:\n\n\ndo you like reading humor? do you like writing with humor? what might that look like for you (if you do choose to use humor)?\nhow can you or your partner “hook” readers at the start of your blog posts? or elsewhere in the writing?\nwhat metaphors might you consider using and how do they help improve understanding of complex topics?\nwhat media might you want to include?\n\n\n\n\n−+\n06:00"
"text": "YOUR TURN\n\n\nDiscuss with your partner some ways to add embellishments to both of your stories. Consider:\n\n\ndo you like reading humor? do you like writing with humor? what might that look like for you (if you do choose to use humor)?\nhow can you or your partner “hook” readers at the start of your blog posts? or elsewhere in the writing?\nwhat metaphors might you consider using and how do they help improve understanding of complex topics?\nwhat media might you want to include?\n\n\n\n\n−+\n10:00"
},
{
"objectID": "course-materials/materials/blogging-tips.html#write-it-start",
Expand Down Expand Up @@ -921,7 +921,7 @@
"href": "course-materials/materials/blogging-tips.html#chunk-options",
"title": "EDS 296",
"section": "",
"text": "Set the appropriate code chunk options\n\nYour data science blog posts will often include example code. Thoughtfully set your code chunk options so that your examples are easy to follow, but don’t bog down your post by requiring readers to scroll past loonnngggg data frames or messages / warnings (unless there’s an important and demonstrative reason to do so). Consider:\n\n\ndo you need to show messages / warnings to demonstrate your point? if not, suppress them (message: false & warning: false)\ndo you need to show the output of your code or just the code? (eval: false & echo: true)\ndo you need to show the code or just the output? (eval: true & echo: true; defaults)"
"text": "Set the appropriate code chunk options\n\nYour data science blog posts will often include example code. Thoughtfully set your code chunk options so that your examples are easy to follow, but don’t bog down your post by requiring readers to scroll past loonnngggg data frames or messages / warnings (unless there’s an important and demonstrative reason to do so). Consider:\n\n\ndo you need to show messages / warnings to demonstrate your point? if not, suppress them: message: false & warning: false\nshow just the code, but not the output (e.g. loading libraries): eval: false & echo: true\nshow just the output (and not code): eval: true & echo: false \n\n\nRemember, you can set options in your blog post’s YAML or on a chunk-by-chunk basis."
},
{
"objectID": "course-materials/materials/blogging-tips.html#consider-code",
Expand Down

0 comments on commit 75054e0

Please sign in to comment.