From 7ab38b4de0dbad91a175e88222cf24e07af3e9d7 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Thu, 26 Sep 2024 14:32:42 +0200 Subject: [PATCH] docs(sessions): :memo: remove all references to R in current files --- preamble/pre-course.qmd | 42 ++++++----------------------------------- preamble/syllabus.qmd | 2 +- 2 files changed, 7 insertions(+), 37 deletions(-) diff --git a/preamble/pre-course.qmd b/preamble/pre-course.qmd index db2f5f7..64a3d44 100644 --- a/preamble/pre-course.qmd +++ b/preamble/pre-course.qmd @@ -2,11 +2,6 @@ {{< include ../includes/_wip.qmd >}} -```{r} -#| echo: false -# To trigger downlit. -``` - In order to participate in this course, you must complete everything in this pre-course tasks section and finish with **completing the [survey]()** at the end. These tasks are designed to make it easier for @@ -25,11 +20,10 @@ early* to make sure everything is properly installed and setup. Here's a quick overview of the tasks you need to do. Specific details about them are found as you work through the tasks. -1. Install a version of R, RStudio, Quarto, and Git that is as updated +1. Install a version of Git that is as updated as possible. For some people, depending on their institution, this task can take the **longest amount of time** because you have to contact your IT to install these packages. -2. Install necessary R packages. 3. TODO: Add more tasks 4. Read the syllabus (@sec-syllabus). 5. Read the [Code of @@ -59,15 +53,6 @@ this website to be aware of: - Folder names always end with a `/`, for example `data/` means the data folder. -- R variables are always shown as is. For instance, for the code - `x <- 10`, `x` is a variable because it was assigned with 10. -- Functions always end with `()`, for instance `mean()` or - `read_csv()`. -- Sometimes functions have their package name appended with `::` to - indicate to run the code from the specific package, since we likely - haven't loaded the package with `library()`. For instance, to - install packages from GitHub using the `{remotes}` package we use - `remotes::install_github()`. You'll learn about this more later. - Reading tasks always start with a statement "Reading task" and are enclosed in a "callout block". Read within this block. We will usually go over the section again to reinforce the concepts and @@ -82,11 +67,7 @@ them. TODO: Link to Guides for installation? -All these programs are required for the course, even Git. Git, which is -a software program to formally manage versions of files, is used because -of it's popularity and the amount of documentation available for it. At -the end of the course, you will be using Git and GitHub to manage your -group assignment. Check out the online book [Happy Git with +Check out the online book [Happy Git with R](https://happygitwithr.com/), especially the "Why Git" section, for an understanding on why we are teaching Git. Windows users tend to have more trouble with installing Git than macOS or Linux users. See the @@ -97,13 +78,8 @@ for help. > *A note to those who have or use work laptops with restrictive > administrative privileges*: You may encounter problems installing > software due to administrative reasons (e.g. you don't have permission -> to install things). Even if you have issues installing or updating the -> latest version of R or RStudio, you will likely be able to continue -> with the course as long as you have the minimum version listed above -> for R and for RStudio. If you have versions of R and RStudio that are -> older than that, you may need to ask your IT department to update your -> software if you can't do this yourself. Unfortunately, Git (and -> Quarto) is not a commonly used software for some organizations, so you +> to install things). +> Git is not a commonly used software for some organizations, so you > may not have it installed and you *will* need to ask IT to install it. > We *require* it for the course, so please make sure to give IT enough > time to be able to install it for you prior to the course. @@ -115,12 +91,6 @@ indicate on the survey that you need help and we can try to book a quick video call to fix the problem. Otherwise, you can come to the course 15-20 minutes earlier to get help. -If you're unable to complete the setup procedure due to unfixable -technical issues, you can use Posit Cloud (to use RStudio on the cloud) -as a final solution in order to participate in the course. For help -setting up Posit Cloud for this course, refer to the [Posit Cloud setup -guide](https://guides.rostools.org/posit-cloud.html). - ## TODO: Next section ## Course basics @@ -131,9 +101,9 @@ what our basic assumptions are about who you are and what you already know. At the end of this section, we'll ask you a few questions to see if you understand what you'll learn in the course. -One goal of the course is to teach about open science, and true to our +One goal of the course is to teach about openness, and true to our mission, we practice what we preach. The course material is publicly -accessible (all on this website) and [openly licensed]() so you can +accessible (all on this website) and [openly licensed](/LICENSE.md) so you can (re-)use it for free! The material is organized in the order that we will cover it in the course. diff --git a/preamble/syllabus.qmd b/preamble/syllabus.qmd index fdacbbd..a4aa52c 100644 --- a/preamble/syllabus.qmd +++ b/preamble/syllabus.qmd @@ -18,7 +18,7 @@ course: way in your team(s) While we have these assumptions to help focus the content of the course, -if you have an interest in learning R but don't fit any of the above +if you have an interest in learning what we teach but don't fit any of the above assumptions, *you are still welcome to attend the course*! We welcome everyone, that is until the course capacity is reached.