Skip to content

Commit 9af622c

Browse files
authored
Make the etherpad template more generic (#353)
* Make the etherpad template more generic * clarify purpose of etherpad template
1 parent 0119512 commit 9af622c

File tree

1 file changed

+40
-190
lines changed

1 file changed

+40
-190
lines changed

instructors/etherpad_template.md

Lines changed: 40 additions & 190 deletions
Original file line numberDiff line numberDiff line change
@@ -1,217 +1,67 @@
11
---
22
title: Etherpad template
3-
subtitle: Template text to paste in to collaborative document
4-
---
5-
6-
# Introduction to the Command Line for Genomic
7-
8-
**Date**
9-
10-
**Instructor**
11-
12-
**Helper**
13-
14-
**Website**
15-
[https://datacarpentry.org/shell-genomics](https://datacarpentry.org/shell-genomics)
16-
17-
## Timings - EDIT FOR YOUR WORKSHOP
18-
19-
Here's a tentative schedule for the workshop
20-
21-
- Introducing the Shell 09:30-10:00 (30 mins)
22-
- Navigating Files and Directories 10:00-10:50 (50 mins)
23-
- Break 10:50-11:05 (15 mins)
24-
- Working with Files and Directories 11:05-11:50 (45 mins)
25-
- Redirection 11:50-12:35 (45 mins)
26-
- Break 12:35-13:30 (55 mins)
27-
- Writing Scripts and Working with Data 13:30-14:10 (40 mins)
28-
- Project Organization 14:10-14:40 (30 mins)
29-
- Wrap up and feedback 14:40-14:55 (15 mins)
30-
31-
## Attendees
32-
33-
Please write your name below to confirm your attendance and mention one thing you hope to learn from this workshop.
34-
35-
1.
36-
2.
37-
3.
38-
4.
39-
40-
## Feedback
41-
42-
Link to feedback form if needed
43-
44-
## [Introducing the Shell](https://datacarpentry.org/shell-genomics/01-introduction.html)
45-
46-
### Exercise:
47-
48-
Use the `-l` option for the `ls` command to display more information for each item in the directory.
49-
50-
What is one piece of additional information this long format gives you that you don’t see with the bare `ls` command?
51-
- - -
52-
53-
## [Navigating Files and Directories](https://datacarpentry.org/shell-genomics/02-the-filesystem.html)
54-
55-
### Exercise: FINDING HIDDEN DIRECTORIES
56-
57-
First navigate to the `shell_data` directory.
58-
There is a hidden directory within this directory. Explore the options for `ls` to find out how to see hidden directories.
59-
List the contents of the directory and identify the name of the text file in that directory.
60-
61-
**Hint:** hidden files and folders in Unix start with ., for example .my_hidden_directory
62-
63-
64-
### Exercise: NAVIGATING PRACTICE
65-
66-
Navigate to your home directory. From there, list the contents of the `untrimmed_fastq` directory.
67-
68-
### Exercise: RELATIVE PATH RESOLUTION
69-
70-
Using the filesystem diagram on the lesson page [below](https://datacarpentry.org/shell-genomics/02-the-filesystem.html), if pwd `displays` `/Users/thing`, what will ls .`./backup display`?
71-
72-
Put a `+` next to the answer you think is correct.
73-
74-
1. ../backup: No such file or directory
75-
2. 2012-12-01 2013-01-08 2013-01-27
76-
3. 2012-12-01/ 2013-01-08/ 2013-01-27/
77-
4. original pnas_final pnas_sub
78-
79-
80-
## [Working with Files and Directories](https://datacarpentry.org/shell-genomics/03-working-with-files.html)
81-
82-
### Exercise:
83-
84-
Do each of the following tasks from your current directory using a single `ls` command for each:
3+
subtitle: Template text to paste into a collaborative document, such as Etherpad.
854

86-
1. List all of the files in `/usr/bin` that start with the letter ‘c’.
87-
2. List all of the files in `/usr/bin` that contain the letter ‘a’.
88-
3. List all of the files in `/usr/bin` that end with the letter ‘o’.
89-
90-
Bonus: List all of the files in `/usr/bin` that contain the letter ‘a’ or the letter ‘c’.
91-
92-
**Hint:** The bonus question requires a Unix wildcard that we haven’t talked about yet. Try searching the internet for information about Unix wildcards to find what you need to solve the bonus problem.
93-
- - -
94-
### Exercise: echo and wildcards
95-
96-
`echo` is a built-in shell command that writes its arguments, like a line of text to standard output.
97-
The `echo` command can also be used with pattern matching characters, such as wildcard characters.
98-
Here we will use the `echo` command to see how the wildcard character is interpreted by the shell.
99-
100-
```bash
101-
$ echo *.fastq
102-
```
103-
What would the output look like if the wildcard could not be matched?
104-
105-
Compare the outputs of
106-
107-
1. `echo *.missing`
108-
2. `ls *.missing`
109-
- - -
110-
### Exercise: command history
111-
112-
Find the line number in your `history` for the command that listed all the `.sh` files in `/usr/bin`.
113-
Rerun that command.
114-
115-
- - -
116-
117-
### Exercise: Examining Files
118-
119-
1. Print out the contents of the `~/shell_data/untrimmed_fastq/SRR097977.fastq` file. What is the last line of the file?
120-
121-
2. From your home directory, and without changing directories, use one short command to print the contents of all of the files in the
122-
`~/shell_data/untrimmed_fastq` directory.
123-
124-
- - -
125-
126-
### Exercise: Examining Files
127-
128-
Use `less` on the file SRR097977.fastq and find the next three nucleotides (characters) after the first instance of the sequence `TTTTT`?
129-
130-
- - -
131-
132-
### Exercise:
133-
134-
Starting in the `shell_data/untrimmed_fastq/` directory, do the following:
135-
136-
1. Make sure that you have deleted your backup directory and all files it contains.
137-
2. Create a backup of each of your FASTQ files using cp. (Note: You’ll need to do this individually for each of the two FASTQ files. We haven’t learned yet how to do this with a wildcard.)
138-
3. Use a wildcard to move all of your backup files to a new backup directory.
139-
4. Change the permissions on all of your backup files to be write-protected.
140-
141-
- - -
142-
143-
## [Redirection](https://datacarpentry.org/shell-genomics/04-redirection.html)
144-
145-
### EXERCISE:
146-
147-
1. Search for the sequence `GNATNACCACTTCC in the `SRR098026.fastq` file. Have your search return all matching lines and the name (or identifier) for each sequence that contains a match.
148-
149-
2. Search for the sequence `AAGTT` in both FASTQ files. Have your search return all matching lines and the name (or identifier) for each sequence that contains a match.
150-
- - -
151-
152-
### EXERCISE
153-
154-
How many sequences are there in `SRR098026.fastq`? Remember that every sequence is formed by four lines.
155-
156-
- - -
157-
158-
### EXERCISE
159-
160-
How many sequences in `SRR098026.fastq` contain at least 3 consecutive Ns?
161-
162-
- - -
163-
164-
### EXERCISE
5+
---
1656

166-
Print the file prefix of all of the `.txt` files in our current directory.
7+
# Timings
8+
Here's a tentative schedule for the workshop.
1679

168-
- - -
10+
## Introducing the shell
11+
09:30-10:00 (30 mins)
16912

170-
### EXERCISE
13+
## Navigating files and directories
14+
10:00-10:50 (50 mins)
17115

172-
Remove `_2019` from all of the `.txt` files.
16+
## Short break
17+
10:50-11:05 (15 mins)
17318

174-
- - -
19+
## Working with files and directories
20+
11:05-11:50 (45 mins)
17521

176-
## [Writing Scripts and Working with Data](https://datacarpentry.org/shell-genomics/05-writing-scripts.html)
22+
## Redirection
23+
11:50-12:35 (45 mins)
17724

178-
### EXERCISE
25+
## Long break
26+
12:35-13:30 (55 mins)
17927

180-
Open README.txt, add the date to the top of the file, and then save it.
28+
## Writing scripts and working with data
29+
13:30-14:10 (40 mins)
18130

182-
- - -
31+
## Project organization
32+
14:10-14:40 (30 mins)
18333

184-
### EXERCISE
34+
## Wrap up and feedback
35+
14:40-14:55 (15 mins)
18536

186-
We want the script to tell us when it’s done.
37+
## Attendees
38+
Please write your name and email below to confirm your attendance and mention one thing you hope to learn from this workshop.
18739

188-
Open `bad-reads-script.sh` and add the line echo `"Script finished!"` after the grep command and save the file.
189-
Run the updated script.
40+
-
41+
-
42+
-
43+
-
19044

191-
- - -
45+
## Notes
46+
Ask your students to keep notes as you go through the lesson's content and exercises.
47+
Links to the episodes are provided below for quick and easy access.
19248

193-
## [Project Organization](https://datacarpentry.org/shell-genomics/06-organization.html)
49+
[Episode 1: Introducing the Shell](https://datacarpentry.org/shell-genomics/01-introduction.html)
19450

195-
### EXERCISE
196-
Use the `mkdir` command to make the following directories:
51+
[Episode 2: Navigating Files and Directories](https://datacarpentry.org/shell-genomics/02-the-filesystem.html)
19752

198-
```
199-
dc_workshop
200-
dc_workshop/docs
201-
dc_workshop/data
202-
dc_workshop/results
203-
```
204-
- - -
53+
[Episode 3: Working with Files and Directories](https://datacarpentry.org/shell-genomics/03-working-with-files.html)
20554

206-
### EXERCISE
55+
[Episode 4: Redirection](https://datacarpentry.org/shell-genomics/04-redirection.html)
20756

208-
Using your knowledge of the shell, use the append redirect >> to create a file called `dc_workshop_log_XXXX_XX_XX.sh` (Use the four-digit year, two-digit month, and two digit day, e.g. `dc_workshop_log_2017_10_27.sh`)
57+
[Episode 5: Writing Scripts and Working with Data](https://datacarpentry.org/shell-genomics/05-writing-scripts.html)
20958

210-
- - -
59+
[Episode 6: Project Organization](https://datacarpentry.org/shell-genomics/06-organization.html)
21160

212-
## Evaluation and Feedback
61+
## Feedback
62+
Link to feedback form if needed.
21363

214-
Your feedback is valuable as it helps instructors and lesson maintainers enhance the content.
64+
Remind students that their feedback is valuable as it helps instructors and lesson maintainers enhance the content.
21565

21666
#### Please list one thing you liked or found particularly useful
21767

0 commit comments

Comments
 (0)