pcmathias / AACC-Introduction-to-R

Course content for How to Truly "Excel" at Data Analysis and Visualization: An Introduction to the R Programming Language
1 stars 1 forks source link

Start exercise / end exercise formatting #14

Closed nkrumm closed 5 years ago

nkrumm commented 5 years ago

Approved format for exercises is to be:

**Exercise**
```{r}

```
**End Exercise**
nkrumm commented 5 years ago

One thought to increase readability would be to use numbered headings:

  1. Overview
  2. Topic 2.1 Subtopic 2.1.1 Exericse 2.2 ...
pcmathias commented 5 years ago

Updated lessons 01 and 03a with exercise formatting

Agree that numbered headings will be clearer but probably have to lock down content before numbering. The Markdown convention is to number will all 1's and it will auto-renumber when things are rearranged, right?

nkrumm commented 5 years ago

I think so, or via the YAML front matter option:

output: 
  html_document:
    number_sections: true

The problem with both of these is that it is not any clearer in the markdown file itself… this may just be a limitation of trying to use both compiled and uncompiled markdown...

On Jul 17, 2018, at 1:13 PM, Patrick Mathias notifications@github.com wrote:

Updated lessons 01 and 03a with exercise formatting

Agree that numbered headings will be clearer but probably have to lock down content before numbering. The Markdown convention is to number will all 1's and it will auto-renumber when things are rearranged, right?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/pcmathias/AACC-Introduction-to-R/issues/14#issuecomment-405712633, or mute the thread https://github.com/notifications/unsubscribe-auth/ABNvnqEtSv8CMBbrUM3mysBLgDfB-Owfks5uHkVXgaJpZM4VTIob.

pcmathias commented 5 years ago

Ok, let's continue with the Exercise and End Exercise format. Based on the experience today we may have to go through and number the exercises, then explicitly tell them what exercises to cover when we pause.

I am wondering if we also should transition to explicitly manually numbering the sections to make it easier to refer to those too.

pcmathias commented 5 years ago

Number exercises within each Rmd @hermands @nkrumm @jwrudolf