Skip to content

Commit

Permalink
docs: 🔥 remove website session (#181)
Browse files Browse the repository at this point in the history
## Description

The website session doesn't nicely fit into the aim of the course. And
it often had issues and was often rushed because previous sessions took
some time. Instead, I think taking the time with the other sessions is
the better approach and maybe we can eventually include a group project
session for the last day.

Closes #150, closes #159, closes #171, closes #143, closes #144, closes
#145

## Checklist

- [x] Formatted Markdown
- [ ] Rendered website locally

Website has an issue with building, I'll solve in a different PR.
  • Loading branch information
lwjohnst86 authored Sep 22, 2024
1 parent 89d619d commit 668e95d
Show file tree
Hide file tree
Showing 10 changed files with 24 additions and 863 deletions.
1 change: 0 additions & 1 deletion _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ book:
- sessions/pipelines.qmd
- sessions/stats-analyses-basic.qmd
- sessions/stats-analyses-multiple.qmd
- sessions/build-website.qmd
appendices:
- appendix/social.qmd
- appendix/resources.qmd
Expand Down
53 changes: 0 additions & 53 deletions appendix/extra-exercises.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -82,56 +82,3 @@ for now, commit the changes to the Git history with
linear_reg_specs <- linear_reg() %>%
set_engine("lm")
```

## Building a website with Quarto

### Exercise: Look through the new website folder

> Time: \~5 minutes.
In your main project folder, there should now be a folder called
`_site/`. Look through the folder. What files are now created? Open up
the `index.html` file in your browser while in RStudio by clicking the
`index.html` file and then selecting the "Open in web browser".

<!-- TODO: Confirm the name of the website folder. -->

Recall how we described what a website is. Can you see how these files
and folders are simply HTML files that the browser shows as website? In
the browser URL, change the `index.html` ending link to
`doc/report.html`. See how it changes to the file based on how it is
structured in the folder?

### Exercise: Make figures prettier

> Time: \~25 minutes
Looking through the [Cell
Reference](https://quarto.org/docs/reference/cells/cells-knitr.html)
documentation, complete these tasks.

- Add a `fig-cap` option to each of the figures.

- For the distribution plot, set the code chunk option `column` to
`page` to make it bigger.

Look through the `{ggplot2}` documentation on `theme_set()` and
`theme()` to update the look of all your figures. In the `setup` code
chunk of the `doc/learning.qmd` file, make a new theme object and use
`theme_set()` to apply that theme to all plots. Use this as a scaffold:

```{{r setup}}
# ... previous code
updated_theme <- theme(
# ... make changes
)
# Or start with a template like theme_classic()
updated_theme <- theme_TEMPLATE() +
theme(
# ...
)
theme_set(updated_theme)
```
16 changes: 8 additions & 8 deletions index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ described in scientific studies. This could have major impact on the
reproducibility an ultimately the reliablity of studies.

This course is designed to address these issues in code-along sessions
(instructor and learner coding together), reading activities, and
exercises using real-world datasets. This website contains all of the
material for the course, from reading material to exercises to images.
It is structured as a book, with "chapters" as lessons, given in order
of appearance. We make heavy use of the website throughout the course
where code-along sessions follow the material on the website nearly
exactly (with slight modifications for time or more detailed
explanations).
(instructor and learner coding together), reading activities, some
discussion activities, and exercises using a real-world dataset. This
website contains all of the material for the course, from reading
material to exercises to images. It is structured as a book, with
"chapters" as lessons, given in order of appearance. We make heavy use
of the website throughout the course where code-along sessions follow
the material on the website nearly exactly (with slight modifications
for time or more detailed explanations).

The course material was created using [Quarto](https://quarto.org/) to
write the lessons and create the book format,
Expand Down
8 changes: 4 additions & 4 deletions preamble/pre-course.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,8 @@ Checking Git config settings:
survey questions**. *Note* that while GitHub is a natural connection to
using Git, given the limited time available, we will only be going over
aspects of GitHub that relate to storing your project Git repository and
setting up the website. If you want to learn more about using GitHub,
check out the
working together. If you want to learn more about using GitHub, check
out the
[session](https://r-cubed-intro.rostools.org/sessions/version-control.html)
on it in the introduction course.

Expand Down Expand Up @@ -232,8 +232,8 @@ without realizing it. That's because Quarto uses the same Markdown
syntax as R Markdown. The only difference is that with Quarto, you can
create more types of output documents (like books, websites, slides),
you have more options for customization, and it's easier to do and learn
than R Markdown. So, for this course, we will eventually use Quarto to
make a website of the analysis that we will do over the course.
than R Markdown. So, for this course, we will use Quarto to create a
report that includes the analysis we will do over the course.

Please do these two tasks:

Expand Down
6 changes: 3 additions & 3 deletions preamble/schedule.csv
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Day 3,10:30,Coffee break and snacks,mug-hot,
Day 3,10:45,Continue previous session,laptop-code,../sessions/stats-analyses-multiple.html
Day 3,12:20,End of session survey,comment-dots,https://docs.google.com/forms/d/e/1FAIpQLScTbsxHSLrQxn38KS7kCklurFrccN8g3kVdm6WTSxEiIBypWg/viewform?usp=sf_link
Day 3,12:30,Lunch,utensils,
Day 3,13:15,Publicizing your analyses with a website,laptop-code,../sessions/build-website.html
Day 3,13:15,TBD,,
Day 3,14:45,Coffee break and snacks,mug-hot,
Day 3,15:00,Continue previous session,laptop-code,../sessions/build-website.html
Day 3,15:00,TBD,,
Day 3,16:00,Closing remarks,person-chalkboard,
Day 3,16:15,End of session and course survey,comment-dots,https://docs.google.com/forms/d/e/1FAIpQLScTbsxHSLrQxn38KS7kCklurFrccN8g3kVdm6WTSxEiIBypWg/viewform?usp=sf_link
Day 3,16:15,End of course survey,comment-dots,https://docs.google.com/forms/d/e/1FAIpQLScTbsxHSLrQxn38KS7kCklurFrccN8g3kVdm6WTSxEiIBypWg/viewform?usp=sf_link
5 changes: 0 additions & 5 deletions preamble/syllabus.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,6 @@ Our specific **learning objectives** are to:
that fit within the conceptual framework of automated pipelines and
that can be used regardless of what statistical method is used.

4. Explain the benefits of why scientific findings (and the pipelines)
should be easily accessible and demonstrate these principles by
building a website in R to display results, using a reproducible and
automated pipeline.

And we **will not** learn:

- Any details on or about specific statistical methods or models
Expand Down
Loading

0 comments on commit 668e95d

Please sign in to comment.