Skip to content

Commit

Permalink
update the pre-course template with the r3admin section templates
Browse files Browse the repository at this point in the history
  • Loading branch information
lwjohnst86 committed Mar 12, 2024
1 parent 87a847f commit 91e063a
Showing 1 changed file with 17 additions and 70 deletions.
87 changes: 17 additions & 70 deletions preamble/pre-course.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -50,76 +50,23 @@ objectives for this page:

1. TODO: List objectives

## Reading the course website

We will explain this a bit during the course, but read this to start
learning how the website is structured and how to read certain things.
Specifically, there are a few "syntax" type formatting of the text in
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
address any questions.

## Installing the latest programs

The first thing to do is to install these programs. You may already have
some of them installed and if you do, please make sure that they are at
least the minimum versions listed below. If not, you will need to update
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
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
section on [Installing Git for
Windows](https://happygitwithr.com/install-git.html#install-git-windows)
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
> 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.
*If you encounter any troubles during these pre-course tasks*, try as
best as you can to complete the task and then let us know about the
issues in the pre-course survey. If you continue having problems,
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).
## Reading the course website {#sec-reading-website}

```{r}
#| echo: false
#| eval: true
#| results: asis
cat(r3admin::read_common("reading-website.md"), sep = "\n")
```

## Installing the latest programs {#sec-install-programs}

```{r}
#| echo: false
#| eval: true
#| results: asis
cat(r3admin::read_common("installing-programs.md"), sep = "\n")
```

## TODO: Next section

Expand Down

0 comments on commit 91e063a

Please sign in to comment.