Skip to content

Commit 91cdc1e

Browse files
authored
Merge pull request #120 from datacarpentry/ErinBecker-patch-1
Update 06-organization.md
2 parents e656384 + 1b50c01 commit 91cdc1e

1 file changed

Lines changed: 25 additions & 15 deletions

File tree

_episodes/06-organization.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,39 @@ keypoints:
1616

1717
# Getting your project started
1818

19-
Project organization is one of the most important parts of a sequencing project, but is often overlooked in the
20-
excitement to get a first look at new data. While it's best to get yourself organized before you begin analysis,
21-
it's never too late to start.
19+
Project organization is one of the most important parts of a sequencing project, and yet is often overlooked amidst the
20+
excitement of getting a first look at new data. Of course, while it's best to get yourself organized before you even begin your analyses,
21+
it's never too late to start, either.
2222

2323
You should approach your sequencing project similarly to how you do a biological experiment and this ideally begins with experimental design. We're going to assume that you've already designed a beautiful
2424
sequencing experiment to address your biological question, collected appropriate samples, and that you have
2525
enough statistical power to answer the questions you're interested in asking. These
2626
steps are all incredibly important, but beyond the scope of our course.
2727
For all of those steps (collecting specimens, extracting DNA, prepping your samples)
28-
you've likely kept a lab notebook that details how and why you did each step, but documentation doesn't stop at
28+
you've likely kept a lab notebook that details how and why you did each step. However, the process of documentation doesn't stop at
2929
the sequencer!
3030

31-
Every computational analysis you do is going to create many files, and inevitably, you'll
32-
want to run some of those analysis again. Genomics projects can quickly accumulate hundreds of files across
33-
tens of folders. Do you remember what PCR conditions you used to create your sequencing library? Probably not.
34-
Similarly, you probably won't remember whether your best alignment results were in `Analysis1`, `AnalysisRedone`,
35-
or `AnalysisRedone2`; or which quality cutoff you used.
31+
Genomics projects can quickly accumulate hundreds of files across
32+
tens of folders. Every computational analysis you perform over the course of your project is going to create
33+
many files, which can especially become a problem when you'll inevitably want to run some of those
34+
analyses again. For instance, you might have made significant headway into your project, but then have to remember the PCR conditions
35+
you used to create your sequencing library months prior.
3636

37-
Luckily, recording your computational experiments is even easier than recording lab data. Copy / paste will become
37+
Other questions might arise along the way:
38+
- What were your best alignment results?
39+
- Which folder were they in: Analysis1, AnalysisRedone, or AnalysisRedone2?
40+
- Which quality cutoff did you use?
41+
- What version of a given program did you implement your analysis in?
42+
43+
Good documentation is key to avoiding this issue, and luckily enough,
44+
recording your computational experiments is even easier than recording lab data. Copy/Paste will become
3845
your best friend, sensible file names will make your analysis understandable by you and your collaborators, and
39-
writing the methods section for your next paper will be easy! Let's look at the best practices for
40-
documenting your genomics project. Your future self will thank you.
46+
writing the methods section for your next paper will be easy! Remember that in any given project of yours, it's worthwhile to consider
47+
a future version of yourself as an entirely separate collaborator. The better your documenation is, the more this 'collaborator' will
48+
feel indebted to you!
4149

50+
With this in mind, let's have a look at the best practices for
51+
documenting your genomics project. Your future self will thank you.
4252

4353
In this exercise we will setup a file system for the project we will be working on during this workshop.
4454

@@ -152,7 +162,7 @@ $ history
152162
The history likely contains many more commands than you have used for the current project. Let's view the last
153163
several commands that focus on just what we need for this project.
154164
155-
View the last n lines of your history (where n = approximately the last few lines you think relevant - for our example we will use the last 7):
165+
View the last n lines of your history (where n = approximately the last few lines you think relevant). For our example, we will use the last 7:
156166
157167
~~~
158168
$ history | tail -n 7
@@ -161,10 +171,10 @@ $ history | tail -n 7
161171
162172
Using your knowledge of the shell, use the append redirect `>>` to create a file called
163173
`dc_workshop_log_XXXX_XX_XX.txt` (Use the four-digit year, two-digit month, and two digit day, e.g.
164-
dc_workshop_log_2017_10_27.txt)
174+
`dc_workshop_log_2017_10_27.txt`)
165175
166176
You may have noticed that your history contains the `history` command itself. To remove this redundancy
167-
from our log, lets use the `nano` text editor to fix the file:
177+
from our log, let's use the `nano` text editor to fix the file:
168178
169179
~~~
170180
$ nano dc_workshop_log_2017_10_27.txt

0 commit comments

Comments
 (0)