Skip to content

Commit 3448702

Browse files
committed
chore(sync): 🔨 synced local '_extensions/rostools/r3-theme/' with remote '_extensions/r3-theme/'
1 parent 08b0c3f commit 3448702

File tree

8 files changed

+71
-58
lines changed

8 files changed

+71
-58
lines changed

_extensions/rostools/r3-theme/_extension.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ contributes:
3838

3939
book:
4040
navbar:
41-
logo: "favicon.ico"
41+
logo: "favicon-white.ico"
4242
logo-alt: "Graphic of a capital R with a 3 as a superscript."
4343
search: true
4444
pinned: true
@@ -53,9 +53,6 @@ contributes:
5353
crossref:
5454
chapters: true
5555

56-
execute:
57-
freeze: auto
58-
5956
knitr:
6057
opts_chunk:
6158
R.options:
14.7 KB
Binary file not shown.
15 KB
Binary file not shown.
320 Bytes
Binary file not shown.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
::: {.callout-tip appearance="minimal" icon="false" collapse="true"}
2+
## Code used in section
3+
4+
This lists *some*, but not all, of the code used in the section. Some
5+
code is incorporated into Markdown content, so is harder to
6+
automatically list here in a code chunk. The code below also includes
7+
the code from the exercises.
8+
9+
<!-- The stringr subset removes code chunks that aren't shown or typed by the learner. -->
10+
11+
```{r code-appendix}
12+
#| echo: true
13+
#| eval: false
14+
#| ref-label: !expr stringr::str_subset(knitr::all_labels(), "^(unnamed-chunk-.*|purl-only-.*|setup|admin-.*|fig-.*)", negate = TRUE)
15+
```
16+
:::

_extensions/rostools/r3-theme/includes/installing-programs-r.qmd

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
The first thing to do is to install these programs. You may already have
2-
some of them installed and if you do, please make sure that they are at
3-
least the minimum versions listed below. If not, you will need to update
4-
them.
1+
In order to participate in the workshop, you'll need to install these
2+
programs. You may already have some of them installed and if you did,
3+
please make sure that they are at least the minimum versions listed
4+
below. If not, you will need to update them.
55

66
::: panel-tabset
77
### Windows
@@ -15,10 +15,10 @@ them.
1515
you have installed it before, check the current version by going to
1616
the menu `Help -> About RStudio`.
1717
3. [Git](https://git-scm.com/download/win): Select the "Click here to
18-
download" link. Git is used throughout many sessions in the courses.
19-
When installing, it will ask for a selecting a "Text Editor" and
20-
while we won't be using this in the course, Git needs to know this
21-
information so choose Notepad.
18+
download" link. Git is used throughout many sessions in the
19+
workshop. When installing, it will ask for a selecting a "Text
20+
Editor" and while we won't be using this in the workshop, Git needs
21+
to know this information so choose Notepad.
2222
4. [Rtools](https://cran.r-project.org/bin/windows/Rtools/): Version
2323
that says "R-release". Rtools is needed in order to build some R
2424
packages. For some computers, installing Rtools can take some time.
@@ -45,7 +45,7 @@ them.
4545
```
4646

4747
3. [Git](https://git-scm.com/download/mac): Git is used throughout many
48-
sessions in the courses. With Homebrew:
48+
sessions in the workshop. With Homebrew:
4949

5050
``` bash
5151
brew install git
@@ -68,17 +68,17 @@ them.
6868
the menu `Help -> About RStudio`.
6969
7070
3. [Git](https://git-scm.com/download/mac): Git is used throughout many
71-
sessions in the courses.
71+
sessions in the workshop.
7272
7373
``` bash
7474
sudo apt install git
7575
```
7676
:::
7777

78-
All these programs are required for the course, even Git. Git, which is
79-
a software program to formally manage versions of files, is used because
80-
of it's popularity and the amount of documentation available for it.
81-
Check out the online book [Happy Git with
78+
All these programs are required for the workshop, even Git. Git, which
79+
is a software program to formally manage versions of files, is used
80+
because of it's popularity and the amount of documentation available for
81+
it. Check out the online book [Happy Git with
8282
R](https://happygitwithr.com/), especially the "Why Git" section, for an
8383
understanding on why we are teaching Git. Windows users tend to have
8484
more trouble with installing Git than macOS or Linux users. See the
@@ -89,8 +89,8 @@ for help.
8989
::: {.callout-note appearance="default"}
9090
Some pictures may show a Git pane in RStudio, but you may not see it. If
9191
you haven't created or opened an RStudio R Project (which is taught in
92-
the introductory course), the Git pane *does not* show up. It only shows
93-
up in R Projects that use Git to track file changes.
92+
the introductory workshop), the Git pane *does not* show up. It only
93+
shows up in R Projects that use Git to track file changes.
9494
:::
9595

9696
::: {.callout-note appearance="default"}
@@ -99,26 +99,26 @@ administrative privileges*: You may encounter problems installing
9999
software due to administrative reasons (e.g. you don't have permission
100100
to install things). Even if you have issues installing or updating the
101101
latest version of R or RStudio, you will likely be able to continue with
102-
the course as long as you have the minimum version listed above for R
102+
the workshop as long as you have the minimum version listed above for R
103103
and for RStudio. If you have versions of R and RStudio that are older
104104
than that, you may need to ask your IT department to update your
105105
software if you can't do this yourself. Unfortunately, Git is not a
106106
commonly used software for some organizations, so you may not have it
107107
installed and you *will* need to ask IT to install it. We *require* it
108-
for the course, so please make sure to give IT enough time to be able to
109-
install it for you prior to the course.
108+
for the workshop, so please make sure to give IT enough time to be able
109+
to install it for you prior to the workshop.
110110
:::
111111

112112
Once R, RStudio, and Git have been installed, open RStudio. *If you
113-
encounter any troubles during these pre-course tasks*, try as best as
113+
encounter any troubles during these pre-workshop tasks*, try as best as
114114
you can to complete the task and then let us know about the issues in
115-
the pre-course survey of the course. If you continue having problems,
116-
indicate on the survey that you need help and we can try to book a quick
117-
video call to fix the problem. Otherwise, you can come to the course
118-
15-20 minutes earlier to get help.
115+
the pre-workshop survey. If you continue having problems, indicate on
116+
the survey that you need help and we can try to book a quick video call
117+
to fix the problem. Otherwise, you can come to the workshop 15-20
118+
minutes earlier to get help.
119119

120120
If you're unable to complete the setup procedure due to unfixable
121121
technical issues, you can use Posit Cloud (to use RStudio on the cloud)
122-
as a final solution in order to participate in the course. For help
123-
setting up Posit Cloud for this course, refer to the [Posit Cloud setup
124-
guide](https://guides.rostools.org/posit-cloud).
122+
as a final solution in order to participate in the workshop. For help
123+
setting up Posit Cloud for this workshop, refer to the [Posit Cloud
124+
setup guide](https://guides.rostools.org/posit-cloud).

_extensions/rostools/r3-theme/includes/install-r-packages.qmd renamed to _extensions/rostools/r3-theme/includes/installing-r-packages.qmd

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ So far, can only be:
1010
-->
1111
```
1212

13-
We will be using specific R packages for the workshop, so you will need to
14-
install them. A detailed walkthrough for installing the necessary
13+
We will be using specific R packages for the workshop, so you will need
14+
to install them. A detailed walkthrough for installing the necessary
1515
packages is available on the [pre-workshop tasks for installing
1616
packages](https://r-cubed-intro.rostools.org/preamble/pre-course.html#installing-r-packages)
1717
section of the introduction workshop, however, you only need to install
@@ -33,30 +33,31 @@ running these commands in the R Console:
3333
3. Install the necessary packages for the workshop:
3434

3535
``` r
36-
r3::install_packages_{{< meta workshop_level >}}
36+
r3::install_packages_{{< meta workshop_level >}}()
3737
```
3838

3939
::: {.callout-warning appearance="default"}
4040
You might encounter an error when running this code. That's ok, you can
4141
fix it if you restart R by going to `Sessions -> Restart R` and re-run
42-
the code in items 2 and 3, it should work. If that also doesn't work, try to
43-
complete the other tasks, complete the survey, and let us know you have a
44-
problem in the survey.
42+
the code in items 2 and 3, it should work. If that also doesn't work,
43+
try to complete the other tasks, complete the survey, and let us know
44+
you have a problem in the survey.
4545
:::
4646

4747
*Note*: When you see a command like `something::something()`, for
48-
example with `r3::install_packages_{{< meta workshop_level >}}`, you would
49-
"read" this as:
48+
example with `r3::install_packages_{{< meta workshop_level >}}()`, you
49+
would "read" this as:
5050

51-
> R, can you please use the `install_packages_{{< meta workshop_level >}}`
52-
> function from the r3 package.
51+
> R, can you please use the
52+
> `install_packages_{{< meta workshop_level >}}()` function from the r3
53+
> package.
5354

5455
The normal way of doing this would be to load the package with
5556
`library(r3)` and then running the command
56-
(`install_packages_{{< meta workshop_level >}}`). But by using the `::`,
57-
we tell R to directly use a function from a package, without needing to
58-
load the package and all of its other functions too. We use this trick
59-
because we only want to use the
60-
`install_packages_{{< meta workshop_level >}}` command from the r3 package
61-
and not have to load all the other functions as well. In this workshop we
62-
will be using `::` often.
57+
(`install_packages_{{< meta workshop_level >}}()`). But by using the
58+
`::`, we tell R to directly use a function from a package, without
59+
needing to load the package and all of its other functions too. We use
60+
this trick because we only want to use the
61+
`install_packages_{{< meta workshop_level >}}()` command from the r3
62+
package and not have to load all the other functions as well. In this
63+
workshop we will be using `::` often.
Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
1-
We will explain this a bit during the workshop, but read this to start
2-
learning how the website is structured and how to read certain things.
3-
Specifically, there are a few "syntax" type formatting of the text in
4-
this website to be aware of:
1+
We will explain this a bit more during the workshop, but read this
2+
section to know how to read certain things on the website. Specifically,
3+
there are a few "syntax" type formatting of text on the website to know
4+
about:
55

66
- Folder names always end with a `/`, for example `data/` means the
77
data folder.
8-
- File names always end with their file extension, for example `content.md`
9-
means the file is a Markdown file.
8+
- File names always end with their file extension, for example
9+
`content.md` means the file is a Markdown file.
1010
- R variables are always shown as is. For instance, for the code
1111
`x <- 10`, `x` is a variable because it was assigned with 10.
1212
- Functions always end with `()`, for instance `mean()` or
1313
`read_csv()`.
14-
- Sometimes functions have their package name appended with `::` to
15-
indicate to run the code from the specific package, since we likely
14+
- Sometimes functions have their package name appended with `::` so
15+
that you run the code from the specific package, since we likely
1616
haven't loaded the package with `library()`. For instance, to
1717
install packages from GitHub using the `{pak}` package we use
18-
`pak::pkg_install("user/packagename")`. You'll learn about this more
19-
later.
18+
`pak::pak("user/packagename")`. You'll learn about this more later.

0 commit comments

Comments
 (0)