Skip to content

Commit

Permalink
docs(preamble): 📝 include some pre-reading tasks in pre-course
Browse files Browse the repository at this point in the history
Closes #56
  • Loading branch information
lwjohnst86 committed Nov 9, 2024
1 parent 996b5d8 commit 66833ea
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 22 deletions.
42 changes: 27 additions & 15 deletions preamble/pre-course.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,13 @@ about them are found as you work through this section.
11. Run a check using `r3::check_project_setup_advanced()` to see that
everything is as expected. You'll later need to paste this output
into the survey.
12. Set some options in RStudio in @sec-quality-of-life.\
12. Set some options in RStudio in @sec-quality-of-life.
13. Read about the basic course details in @sec-course-details.
14. Read the syllabus in @sec-syllabus.
15. Read the [Code of
Conduct](https://guides.rostools.org/conduct.html).
16. **Complete the pre-course
16. Pre-read some content in @sec-pre-reading.
17. **Complete the pre-course
[survey](https://docs.google.com/forms/d/e/1FAIpQLSfzTLrLFyQHj79YGaCQDN5fUZ_9et1qdmtDGiq6gNPGzFSCyQ/viewform?usp=sf_link)**.
This survey is pretty quick, maybe \~10 minutes.

Expand Down Expand Up @@ -122,7 +123,7 @@ If you *have not* used it, please do these tasks:
from the introduction course. Specifically, type in the RStudio
Console:

```{.r filename="Console"}
``` {.r filename="Console"}
# There will be a pop-up to type in your name (first and
# last), as well as your email
r3::setup_git_config()
Expand Down Expand Up @@ -359,8 +360,8 @@ AdvancedR3
└── nmr-omics.R
```

And when using `readr::read_csv()`, the created dataset in `data/lipidomics.csv`
should look like:
And when using `readr::read_csv()`, the created dataset in
`data/lipidomics.csv` should look like:

```{r show-created-data}
#| eval: true
Expand Down Expand Up @@ -392,11 +393,11 @@ git_ci(
)
```

```{.r filename="Console"}
``` {.r filename="Console"}
r3::check_project_setup_advanced()
```

```
```
Show folders and files of project:
• Please copy and paste this output into the survey question:
/home/luke/Desktop/AdvancedR3
Expand Down Expand Up @@ -450,19 +451,30 @@ what our basic assumptions are about who you are and what you know. The
final pre-course task is to complete a survey that asks if you've read
it and if it matches you.

One goal of the course is to teach about open science, and true to our
mission, we practice what we preach. The course material is publicly
accessible (all on this website) and [openly
licensed](/index.qmd#licensing) so you can use and re-use it for free!
The material and table of contents on the side is listed in the order
that we will cover in the course.

We have a [Code of Conduct](https://guides.rostools.org/conduct.html).
If you haven't read it, **read it now**. The survey at the end will ask
about Conduct. We want to make sure this course is a supportive and safe
environment for learning, so this Code of Conduct is important.

You're almost done. Please fill out the [**pre-course
## Brief pre-reading {#sec-pre-reading}

An important component of learning is repeated exposure to a concept or
skill. So, while we will tell you this information during the course,
and in many cases you will also read it *during* the course, we want to
introduce some repetition here by reading the sections list below. This
will not only mentally prepare you for the content of the course, but
will also give you a bigger overview of what you will be learning and
doing. So, please read:

1. @sec-big-picture
2. @sec-smoother-collaboration-learning-objectives
3. @sec-pipelines-learning-objectives
4. @sec-stats-analyses-basic-learning-objectives
5. @sec-stats-analyses-multiple-learning-objectives

## Fill in survey {#sec-survey}

You're almost done! :tada: Please fill out the [**pre-course
survey**](https://docs.google.com/forms/d/e/1FAIpQLSfzTLrLFyQHj79YGaCQDN5fUZ_9et1qdmtDGiq6gNPGzFSCyQ/viewform?usp=sf_link)
to finish this assignment.

Expand Down
8 changes: 6 additions & 2 deletions preamble/syllabus.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,12 @@ and to build networks of support and collaboration.

The specific software and technologies we will cover in this course are
R, RStudio, Git, GitHub, and Quarto, while the specific R packages are
`{styler}`, `{targets}`, and several of the `{tidymodels}`
packages.
`{styler}`, `{targets}`, and several of the `{tidymodels}` packages.

One goal of the course is to teach about open science, and true to our
mission, we practice what we preach. The course material is publicly
accessible (all on this website) and [openly
licensed](/index.qmd#licensing) so you can use and re-use it for free!

## Is this course for you?

Expand Down
2 changes: 1 addition & 1 deletion sessions/introduction.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The slides contain speaking notes that you can view by pressing 'S' on
the keyboard.
:::

## The Big Picture
## The Big Picture {#sec-big-picture}

::: callout-note
## Reading task: \~10 minutes
Expand Down
2 changes: 1 addition & 1 deletion sessions/pipelines.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ and outputs, and use a system that tracks those inputs and outputs, you
can make things a lot easier for yourself and others. This session is
about applying tools that make and manage these pipelines.

## Learning objectives
## Learning objectives {#sec-pipelines-learning-objectives}

The overall objective for this session is to:

Expand Down
2 changes: 1 addition & 1 deletion sessions/smoother-collaboration.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ consider for workflows and processes to effectively collaborate with
others. This session is about making use of more automated ways of
structuring data analysis projects to ease collaboration.

## Learning objectives
## Learning objectives {#sec-smoother-collaboration-learning-objectives}

The overall objective for this session is to:

Expand Down
2 changes: 1 addition & 1 deletion sessions/stats-analyses-basic.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ vastly simplify the analysis. This session will be covering a general
framework for running statistical analyses, regardless of the exact
statistical method.

## Learning objectives
## Learning objectives {#sec-stats-analyses-basic-learning-objectives}

The overall objective for this session is to:

Expand Down
2 changes: 1 addition & 1 deletion sessions/stats-analyses-multiple.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ complex actions and run large numbers of statistical analyses. This
session will be about using functional programming in the context of
statistical analysis.

## Learning objectives
## Learning objectives {#sec-stats-analyses-multiple-learning-objectives}

The overall objective for this session is to:

Expand Down

0 comments on commit 66833ea

Please sign in to comment.