Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: ✏️ rename "course" to "tutorial" #37

Merged
merged 1 commit into from
Feb 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Copyright (c) 2025 Luke W. Johnston and Signe Kirk Brødbæk

<a rel="license" href="https://creativecommons.org/licenses/by/4.0/"><img src="https://i.creativecommons.org/l/by/4.0/88x31.png" alt="Creative Commons License" style="border-width:0"/></a>

The course material is licensed under the [Creative Commons Attribution
The tutorial material is licensed under the [Creative Commons Attribution
4.0 International License](https://creativecommons.org/licenses/by/4.0/)
License.
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,47 @@

## Description

TODO: Very brief intro, motivation, and overview of course.
TODO: Very brief intro, motivation, and overview of tutorial.

This repository contains the lesson, lecture, and assignment material
for the course, including the website source files and other associated
course administration files.
for the tutorial, including the website source files and other associated
tutorial administration files.

For more detail on the course, check out the [welcome page]().
For more detail on the tutorial, check out the [welcome page]().

## Instructional Design

The lectures and lessons in this course are designed to be presented
The lectures and lessons in this tutorial are designed to be presented
primarily with a participatory live-coding approach. This involves an
instructor typing and running code in
[RStudio](https://posit.co/products/open-source/rstudio/) in front of
the class, while the class follows along using their own computers.
Challenges are interspersed in the lesson material, allowing
participants to collaboratively work on smaller coding problems for a
few minutes. All lesson materials are provided ahead of time on the
course website for participants to refer to during lectures.
tutorial website for participants to refer to during lectures.

## Lesson content

The teaching material is found mainly in these locations:

- `index.Rmd`: Contains the overview of the course.
- `preamble/` folder: Contains the files necessary for use before the
course, for instance the syllabus, schedule, and pre-course tasks.
- `sessions/` folder: Contains the files used during the course (e.g.
- `index.Rmd`: Contains the overview of the tutorial.
- `preamble/` folder: Contains the files necessary for use before the
tutorial, for instance the syllabus, schedule, and pre-tutorial tasks.
- `sessions/` folder: Contains the files used during the tutorial (e.g.
code-along material)
- `appendix/` folder: Contains the files used to support the course,
such as pre-course tasks, code of conduct, resources, and
- `appendix/` folder: Contains the files used to support the tutorial,
such as pre-tutorial tasks, code of conduct, resources, and
instructions for instructors.
- `slides/`: The lecture slides are rendered into HTML slides from
- `slides/`: The lecture slides are rendered into HTML slides from
Markdown.

The website is generated from [Quarto](https://quarto.org/), so it
follows the file and folder structure conventions from that package.

## Contributing

If you are interested in contributing to the course material, please
If you are interested in contributing to the tutorial material, please
refer to the [contributing guidelines](CONTRIBUTING.md). For guidelines
on how to be a helper or instructor, check out the [For
Instructors](https://r-cubed.rostools.org/for-instructors.html) page.
Expand All @@ -53,7 +53,7 @@ this project, you agree to abide by its terms.

## Re-use

The course is largely designed to be taught in the order given, as each
The tutorial is largely designed to be taught in the order given, as each
session builds off of the previous ones. The easiest way to use this
material is to use it as-is, making use of the tips and instructions
found throughout this page. The only thing you might want to make as
Expand All @@ -68,7 +68,7 @@ build your own website from the material is outside the scope of this
document but you can find more information on Quarto's
[Publishing](https://quarto.org/docs/publishing/) page.

To help with general admin tasks of running the course, there is the
To help with general admin tasks of running the tutorial, there is the
[r3admin](https://github.com/rostools/r3admin) R package. For details of
the license and acknowledgement of content used from sources, see the
[license](TODO) page of the website.
Expand All @@ -82,4 +82,3 @@ Please cite the material as:
Or as BibTeX:

TODO: Update

4 changes: 2 additions & 2 deletions _extensions/rostools/r3-theme/text-snippet.lua
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ computer to indicate this to the instructor :womans_hat: :tophat:
]]

local faq_text = [[
Throughout the many times we've taught this course and others, we
Throughout the many times we've taught this tutorial and others, we
get asked a lot of questions. We have a [Frequently Asked
Questions](https://guides.rostools.org/faq) page for keeping track of
some of these questions. Check out this page, maybe your question has
Expand Down Expand Up @@ -55,7 +55,7 @@ a code chunk. The code below also includes the code from the exercises.
]]

local discord_text = [[
If you want to get help virtually or after the course, you can join the
If you want to get help virtually or after the tutorial, you can join the
[Discord channel](https://discord.gg/WKyTF5yXBJ) where you can ask questions
in the `questions-or-advice` text channel.
]]
Expand Down
2 changes: 1 addition & 1 deletion appendix/for-instructors.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A more general guide to instructing or helping is found on the
[Guides](https://guides.rostools.org/) website. This page has
information relevant specifically to this course.
information relevant specifically to this tutorial.

## Pre-tutorial tasks

Expand Down
4 changes: 2 additions & 2 deletions preamble/schedule.qmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Schedule {#sec-schedule}

The course is structured as a single participatory live-coding
The tutorial is structured as a single participatory live-coding
session interspersed with a few hands-on exercises. The
*general* schedule outline is shown in the below table.
Instead, it is meant to be an approximate
Expand All @@ -9,7 +9,7 @@ guide and overview.
| Session topic |
|:---|
| {{< fa mug-hot >}} Arrival, coffee and snacks |
| {{< fa person-chalkboard >}} [Introduction to the course](/sessions/introduction.qmd) |
| {{< fa person-chalkboard >}} [Introduction to the tutorial](/sessions/introduction.qmd) |
| {{< fa person-chalkboard >}} [The basics of GitHub and Git](/sessions/basics.qmd) |
| {{< fa mug-hot >}} Short break |
| {{< fa laptop-code >}} [Working with files on GitHub](/sessions/working-with-files.qmd) |
Expand Down
4 changes: 2 additions & 2 deletions preamble/syllabus.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ in the tutorial, such as one or more of the following:
- You are able to and are comfortable enough with only working on files
through a web browser interface (like GitHub's interface).

While we have these assumptions to help focus the content of the course,
While we have these assumptions to help focus the content of the tutorial,
if you have an interest in the tutorial but don't fit any of the
assumptions, *you are still welcome to attend*! We welcome
everyone, that is until capacity has been reached.

In addition to the assumptions, we also have a fairly focused scope for
teaching and expectations for learning. So this may also help you decide
if this course is for you.
if this tutorial is for you.

- We will only interact with GitHub from the website and from a web
browser.
Expand Down
2 changes: 1 addition & 1 deletion sessions/introduction.qmd
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Introduction to course {#sec-introduction}
# Introduction to tutorial {#sec-introduction}

> [**Introduction slides**](../slides/introduction.html)

Expand Down
2 changes: 1 addition & 1 deletion slides/introduction.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ format: r3-theme-revealjs
search: false
---

# Welcome to the TODO: add course name
# Welcome to the TODO: add tutorial name