Skip to content

Commit 8e8394d

Browse files
committed
Edited screenshots with better instructions; finished next iteration of separating ch 1 into a, b, and c
1 parent 217b12d commit 8e8394d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+210
-152
lines changed

Chapter-Instructions/Chapter_00_Instructions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ In RStudio:
6565
alt="Create New Project in RStudio with 'File', 'New Project...'"
6666
style="width: 55%;">
6767

68-
<img src="Images/project_in_existing_directory.png"
69-
alt="Create New Project in RStudio with 'New Directory'"
68+
<img src="Images/project_in_new_directory.png"
69+
alt="Create new project in RStudio with 'New Directory'"
7070
style="width: 55%;">
7171

7272
<img src="Images/new_quarto_project.png"
@@ -134,9 +134,9 @@ repository (i.e. the directory/workspace your new project exists in.)
134134
alt="GitHub Desktop visual with buttons to add your new local repository"
135135
style="width: 55%;">
136136

137-
You will see something similar to the followingKeep in mind some
138-
listed files (on the left of your screen) may be different due to
139-
RStudio version differences.
137+
You will see something similar to the following. (**Hint**: Keep in mind
138+
some listed files on the left of your screen may be different due to
139+
RStudio version differences)
140140

141141
<img src="Images/new_repo_in_github_desktop.png"
142142
alt="GitHub Desktop screen upon adding new repository; files listed on the left"

Chapter-Instructions/Chapter_00_Instructions.qmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ In RStudio:
6262
alt="Create New Project in RStudio with 'File', 'New Project...'"
6363
style="width: 55%;">
6464

65-
<img src="Images/project_in_existing_directory.png"
66-
alt="Create New Project in RStudio with 'New Directory'"
65+
<img src="Images/project_in_new_directory.png"
66+
alt="Create new project in RStudio with 'New Directory'"
6767
style="width: 55%;">
6868

6969
<img src="Images/new_quarto_project.png"
@@ -127,8 +127,8 @@ Let's open GitHub Desktop and follow the instructions to add your new repository
127127
alt="GitHub Desktop visual with buttons to add your new local repository"
128128
style="width: 55%;">
129129

130-
You will see something similar to the following...
131-
Keep in mind some listed files (on the left of your screen) may be different due to RStudio version differences.
130+
You will see something similar to the following.
131+
(**Hint**: Keep in mind some listed files on the left of your screen may be different due to RStudio version differences)
132132

133133
<img src="Images/new_repo_in_github_desktop.png"
134134
alt="GitHub Desktop screen upon adding new repository; files listed on the left"

Chapter-Instructions/Chapter_01a_Instructions.md

Lines changed: 63 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
# Chapter 1a, RStudio
1+
# Chapter 1a, RStudio and GitHub
22

33

44
In this first section of Chapter 1 you will create and work on a new
55
branch on GitHub, create a **Quarto document**, and have a brief
6-
introduction to plotting.
6+
introduction to plotting. Then, you will **push** your Chapter 1a work
7+
to a Chapter-1a branch, for your mentor’s review.
78

89
------------------------------------------------------------------------
910

@@ -22,14 +23,14 @@ push your corresponding chapters’ work to.
2223

2324
- In **GitHub Desktop**, click Current Branch –\> New Branch
2425

25-
<img src="Images/create_new_ch_1_branch.png"
26-
alt="GitHub Desktop screen where 'Current Branch' is selected and 'New Branch' button is visible"
26+
<img src="Images/create_new_ch_1a_branch.png"
27+
alt="GitHub Desktop screen where 'Current Branch' is selected and 'New Branch' button is visible. Both are circled in red."
2728
style="width: 55%;">
2829

29-
- Name the branch ‘chapter-01’ and click ‘Create Branch’
30+
- Name the branch ‘chapter-01a’ and click ‘Create Branch’
3031

31-
<img src="Images/name_new_branch_ch_1.png"
32-
alt="GitHub Desktop screen upon creation of new branch, a name 'chapter-01' is given and 'Create Branch' button is visible in blue"
32+
<img src="Images/name_new_branch_ch_1a.png"
33+
alt="GitHub Desktop screen upon creation of new branch, a name 'chapter-01a' is given and 'Create Branch' button is visible in blue"
3334
style="width: 55%;">
3435

3536
**Create Your First Quarto Notebook:**
@@ -71,23 +72,23 @@ in your R Console.
7172
- File –\> New File –\> Quarto Document…
7273

7374
<img src="Images/create_new_quarto_file.png"
74-
alt="RStudio screen showing button navigation to create a new quarto document"
75+
alt="RStudio screen showing button navigation to create a new quarto document. 'File', 'New file', and Quarto document...' are all circled in red."
7576
style="width: 55%;">
7677

7778
4. Name your Quarto document
7879

79-
- Title file ‘Chapter 1
80+
- Title file ‘Chapter 1a
8081
- **deselect** ‘Use visual markdown editor’
8182
- Click ‘Create Empty Document’
8283

8384
<img src="Images/name_new_quarto_file.png"
84-
alt="RStudio screen upon creating new quarto document: title box changed to 'Chapter 1', 'Use visual markdown editor' is deselected, and 'Create Empty Document' button is present and circled in red."
85+
alt="RStudio screen upon creating new quarto document: title box changed to 'Chapter 1a', 'Use visual markdown editor' is deselected, and 'Create Empty Document' button is present and circled in red."
8586
style="width: 55%;">
8687

8788
You will see something like the following…
8889

89-
<img src="Images/ch_1_quarto_file.png"
90-
alt="RStudio screen with newly created 'Chapter 1' quarto document. The file is blank besides the YAML header with 'title: Chapter 1' and 'format: html'."
90+
<img src="Images/ch_1a_quarto_file.png"
91+
alt="RStudio screen with newly created 'Chapter 1a' quarto document. The file is blank besides the YAML header with 'title: Chapter 1a' and 'format: html'."
9192
style="width: 55%;">
9293

9394
5. Change the YAML Header
@@ -101,7 +102,7 @@ output is a markdown file. We want to render to a gfm (GitHub Flavored
101102
Markdown), specifically, as it is optimized for viewing on GitHub.
102103

103104
<img src="Images/change_yaml_header.png"
104-
alt="Cropped screenshot of top left corner of RStudio screen. The YAML header has the correct 'Chapter 1' title but the output format has been changed to 'format: gfm'."
105+
alt="Cropped screenshot of top left corner of RStudio screen. The YAML header has the correct 'Chapter 1a' title but the output format has been changed to 'format: gfm'."
105106
style="width: 55%;">
106107

107108
6. Load Libraries from the Installed Packages.
@@ -111,6 +112,8 @@ Next, we need to load the libraries from the packages into our new
111112
project. Unlike installing packages, you need to load the libraries each
112113
new session.
113114

115+
**Load Libraries**
116+
114117
Thus far you have been working in your Console. You will now switch to
115118
writing commands in your own **Quarto document**! But don’t worry, your
116119
Console will still appear at the bottom of your RStudio screen. To
@@ -140,7 +143,7 @@ dropdown box will appear, click “Run Current Chunk” to run the
140143
**entire** chunk.
141144

142145
<img src="Images/run_current_chunk.png"
143-
alt="RStudio screen navigated to the top right 'Run' button, circled in red."
146+
alt="RStudio screen navigated to the top right 'Run' button and 'Run current chunk' button, both circled in red."
144147
style="width: 55%;">
145148

146149
You will see the following output:
@@ -161,7 +164,7 @@ library(ggthemes)
161164
```
162165

163166
<img src="Images/run_selected_lines.png"
164-
alt="RStudio screen when running selected lines of a command. In this case, to load two libraries, 'palmerpenguins' and 'ggthemes'."
167+
alt="RStudio screen when running selected lines of a command."
165168
style="width: 55%;">
166169

167170
AMAZING work! Now, let’s *really* get into it.
@@ -234,5 +237,50 @@ right arrow located on the top of your RStudio screen.
234237

235238
------------------------------------------------------------------------
236239

240+
Now, to wrap up Chapter 1a, you will learn to use GitHub to make your
241+
work viewable to others (and also reproducible)! You will push your
242+
Chapter 1a work to GitHub, creating a pull request in the process. This
243+
pull request will allow a mentor to review your work each chapter.
244+
245+
Remember that Chapter 1a branch you created? After you save your Quarto
246+
notebook, you are going to push all of your new Chapter 1a changes to
247+
that branch on GitHub, so your work will be visible on the
248+
UCSC-Treehouse organization.
249+
250+
Lastly, you will request your mentor as a ‘reviewer’, so they can check
251+
over your work *before* you officially merge it with the main branch.
252+
253+
Navigate back to **GitHub Desktop**… You should see your new changes
254+
highlighted in red.
255+
256+
1. Push new Chapter 1a changes to chapter-01a branch
257+
258+
<img src="Images/push_ch_1a_to_ch_1a_branch.png"
259+
alt="Cropped image of bottom left corner of GitHub Desktop screen where description 'Create and complete chapter 1a' is given and blue 'Commit 1 file to chapter-01a' button is circled in red at the bottom."
260+
style="width: 55%;">
261+
262+
2. Publish the new chapter-01a branch
263+
264+
<img src="Images/publish_ch_1a_branch.png"
265+
alt="GitHub Desktop screen where blue 'Publish branch' button is present and circled in red."
266+
style="width: 55%;">
267+
268+
3. Create a pull request
269+
270+
<img src="Images/create_pull_request.png"
271+
alt="GitHub Desktop screen after committing changes to new branch, prompted to click 'Create Pull Request' button in blue."
272+
style="width: 55%;">
273+
274+
You will be relocated to the **GitHub browser**.
275+
276+
1. Add your mentor as a reviewer (**Note**: here I use ‘hbeale’ but
277+
make sure you are adding *your* mentor’s GitHub id)
278+
279+
<img src="Images/add_reviewer_to_pull_request.png"
280+
alt="GitHub browser screen upon creating a pull request. On the right-hand side, a reviewer is added. The example shows 'hbeale' as reviewer, circled in red."
281+
style="width: 55%;">
282+
283+
------------------------------------------------------------------------
284+
237285
**NEXT UP:** [Chapter
238286
1b](https://github.com/UCSC-Treehouse/Essential-skills-for-Treehouse-computational-research/blob/main/Chapter-Instructions/Chapter_01b_Instructions.md)

Chapter-Instructions/Chapter_01a_Instructions.qmd

Lines changed: 57 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
title: "Chapter 1a, RStudio"
2+
title: "Chapter 1a, RStudio and GitHub"
33
format: gfm
44
---
55

66
In this first section of Chapter 1 you will create and work on a new branch on GitHub, create a **Quarto document**, and have a brief introduction to plotting.
7+
Then, you will **push** your Chapter 1a work to a Chapter-1a branch, for your mentor's review.
78

89
------------------------------------------------------------------------
910

@@ -19,14 +20,14 @@ For each chapter you work through, you will create a new quarto document *and* a
1920

2021
- In **GitHub Desktop**, click Current Branch --\> New Branch
2122

22-
<img src="Images/create_new_ch_1_branch.png"
23-
alt="GitHub Desktop screen where 'Current Branch' is selected and 'New Branch' button is visible"
23+
<img src="Images/create_new_ch_1a_branch.png"
24+
alt="GitHub Desktop screen where 'Current Branch' is selected and 'New Branch' button is visible. Both are circled in red."
2425
style="width: 55%;">
2526

26-
- Name the branch 'chapter-01' and click 'Create Branch'
27+
- Name the branch 'chapter-01a' and click 'Create Branch'
2728

28-
<img src="Images/name_new_branch_ch_1.png"
29-
alt="GitHub Desktop screen upon creation of new branch, a name 'chapter-01' is given and 'Create Branch' button is visible in blue"
29+
<img src="Images/name_new_branch_ch_1a.png"
30+
alt="GitHub Desktop screen upon creation of new branch, a name 'chapter-01a' is given and 'Create Branch' button is visible in blue"
3031
style="width: 55%;">
3132

3233
**Create Your First Quarto Notebook:**
@@ -63,23 +64,23 @@ This is always done in your R Console.
6364
- File --\> New File --\> Quarto Document...
6465

6566
<img src="Images/create_new_quarto_file.png"
66-
alt="RStudio screen showing button navigation to create a new quarto document"
67+
alt="RStudio screen showing button navigation to create a new quarto document. 'File', 'New file', and Quarto document...' are all circled in red."
6768
style="width: 55%;">
6869

6970
4. Name your Quarto document
7071

71-
- Title file 'Chapter 1'
72+
- Title file 'Chapter 1a'
7273
- **deselect** 'Use visual markdown editor'
7374
- Click 'Create Empty Document'
7475

7576
<img src="Images/name_new_quarto_file.png"
76-
alt="RStudio screen upon creating new quarto document: title box changed to 'Chapter 1', 'Use visual markdown editor' is deselected, and 'Create Empty Document' button is present and circled in red."
77+
alt="RStudio screen upon creating new quarto document: title box changed to 'Chapter 1a', 'Use visual markdown editor' is deselected, and 'Create Empty Document' button is present and circled in red."
7778
style="width: 55%;">
7879

7980
You will see something like the following...
8081

81-
<img src="Images/ch_1_quarto_file.png"
82-
alt="RStudio screen with newly created 'Chapter 1' quarto document. The file is blank besides the YAML header with 'title: Chapter 1' and 'format: html'."
82+
<img src="Images/ch_1a_quarto_file.png"
83+
alt="RStudio screen with newly created 'Chapter 1a' quarto document. The file is blank besides the YAML header with 'title: Chapter 1a' and 'format: html'."
8384
style="width: 55%;">
8485

8586
5. Change the YAML Header
@@ -91,7 +92,7 @@ Changing the header of the document to 'format: gfm' ensures that the output is
9192
We want to render to a gfm (GitHub Flavored Markdown), specifically, as it is optimized for viewing on GitHub.
9293

9394
<img src="Images/change_yaml_header.png"
94-
alt="Cropped screenshot of top left corner of RStudio screen. The YAML header has the correct 'Chapter 1' title but the output format has been changed to 'format: gfm'."
95+
alt="Cropped screenshot of top left corner of RStudio screen. The YAML header has the correct 'Chapter 1a' title but the output format has been changed to 'format: gfm'."
9596
style="width: 55%;">
9697

9798
6. Load Libraries from the Installed Packages.
@@ -100,6 +101,8 @@ Installing new packages does not mean they are ready to use just yet.
100101
Next, we need to load the libraries from the packages into our new project.
101102
Unlike installing packages, you need to load the libraries each new session.
102103

104+
**Load Libraries**
105+
103106
Thus far you have been working in your Console.
104107
You will now switch to writing commands in your own **Quarto document**!
105108
But don't worry, your Console will still appear at the bottom of your RStudio screen.
@@ -125,7 +128,7 @@ To run a command, click the "Run" button on the top right of your RStudio screen
125128
A dropdown box will appear, click "Run Current Chunk" to run the **entire** chunk.
126129

127130
<img src="Images/run_current_chunk.png"
128-
alt="RStudio screen navigated to the top right 'Run' button, circled in red."
131+
alt="RStudio screen navigated to the top right 'Run' button and 'Run current chunk' button, both circled in red."
129132
style="width: 55%;">
130133

131134
You will see the following output:
@@ -146,7 +149,7 @@ library(ggthemes)
146149
```
147150

148151
<img src="Images/run_selected_lines.png"
149-
alt="RStudio screen when running selected lines of a command. In this case, to load two libraries, 'palmerpenguins' and 'ggthemes'."
152+
alt="RStudio screen when running selected lines of a command."
150153
style="width: 55%;">
151154

152155
AMAZING work! Now, let's *really* get into it.
@@ -210,4 +213,44 @@ Render your Chapter 1a work by clicking the "Render" button by the blue right ar
210213

211214
------------------------------------------------------------------------
212215

216+
Now, to wrap up Chapter 1a, you will learn to use GitHub to make your work viewable to others (and also reproducible)!
217+
You will push your Chapter 1a work to GitHub, creating a pull request in the process.
218+
This pull request will allow a mentor to review your work each chapter.
219+
220+
Remember that Chapter 1a branch you created?
221+
After you save your Quarto notebook, you are going to push all of your new Chapter 1a changes to that branch on GitHub, so your work will be visible on the UCSC-Treehouse organization.
222+
223+
Lastly, you will request your mentor as a 'reviewer', so they can check over your work *before* you officially merge it with the main branch.
224+
225+
Navigate back to **GitHub Desktop**...
226+
You should see your new changes highlighted in red.
227+
228+
1. Push new Chapter 1a changes to chapter-01a branch
229+
230+
<img src="Images/push_ch_1a_to_ch_1a_branch.png"
231+
alt="Cropped image of bottom left corner of GitHub Desktop screen where description 'Create and complete chapter 1a' is given and blue 'Commit 1 file to chapter-01a' button is circled in red at the bottom."
232+
style="width: 55%;">
233+
234+
2. Publish the new chapter-01a branch
235+
236+
<img src="Images/publish_ch_1a_branch.png"
237+
alt="GitHub Desktop screen where blue 'Publish branch' button is present and circled in red."
238+
style="width: 55%;">
239+
240+
3. Create a pull request
241+
242+
<img src="Images/create_pull_request.png"
243+
alt="GitHub Desktop screen after committing changes to new branch, prompted to click 'Create Pull Request' button in blue."
244+
style="width: 55%;">
245+
246+
You will be relocated to the **GitHub browser**.
247+
248+
1. Add your mentor as a reviewer (**Note**: here I use 'hbeale' but make sure you are adding *your* mentor's GitHub id)
249+
250+
<img src="Images/add_reviewer_to_pull_request.png"
251+
alt="GitHub browser screen upon creating a pull request. On the right-hand side, a reviewer is added. The example shows 'hbeale' as reviewer, circled in red."
252+
style="width: 55%;">
253+
254+
------------------------------------------------------------------------
255+
213256
**NEXT UP:** [Chapter 1b](https://github.com/UCSC-Treehouse/Essential-skills-for-Treehouse-computational-research/blob/main/Chapter-Instructions/Chapter_01b_Instructions.md)

Chapter-Instructions/Chapter_01b_Instructions.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ Now that you have created your first plot, you will begin to explore
55
data visualization with **ggplot2**: navigating variables, distribution,
66
plots, and varying aesthetic options.
77

8+
**REMEMBER**: **For each of the following chapters, create a new branch
9+
corresponding to that chapter.** **Continue to work on the examples,
10+
exercises, and write any notes you may want.** **Then, save and render
11+
the document, before committing and pushing those changes to the
12+
corresponding new branch on GitHub desktop.** **Create a pull request,
13+
requesting your mentor’s review.** **You will learn what happens after
14+
your pull request is approved in Chapter 1c.**
15+
16+
------------------------------------------------------------------------
17+
818
First, we need to define a **geom**: a geometrical object that a plot
919
uses to represent data. For example, bar charts use bar geoms with
1020
geom_bar(), line charts can be displayed with line geoms using

Chapter-Instructions/Chapter_01b_Instructions.qmd

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ format: gfm
55

66
Now that you have created your first plot, you will begin to explore data visualization with **ggplot2**: navigating variables, distribution, plots, and varying aesthetic options.
77

8+
**REMEMBER**: **For each of the following chapters, create a new branch corresponding to that chapter.**
9+
**Continue to work on the examples, exercises, and write any notes you may want.**
10+
**Then, save and render the document, before committing and pushing those changes to the corresponding new branch on GitHub desktop.**
11+
**Create a pull request, requesting your mentor's review.**
12+
**You will learn what happens after your pull request is approved in Chapter 1c.**
13+
14+
------------------------------------------------------------------------
15+
816
First, we need to define a **geom**: a geometrical object that a plot uses to represent data.
917
For example, bar charts use bar geoms with geom_bar(), line charts can be displayed with line geoms using geom_line(), and boxplots with geom_boxplot().
1018
Let's create a scatterplot using a point geom with geom_point():

0 commit comments

Comments
 (0)