added readme file
authorRichard <richard.neher@tuebingen.mpg.de>
Thu, 26 Sep 2013 16:29:34 +0000 (18:29 +0200)
committerRichard <richard.neher@tuebingen.mpg.de>
Thu, 26 Sep 2013 16:29:34 +0000 (18:29 +0200)
README.txt [new file with mode: 0644]

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..fa61c25
--- /dev/null
@@ -0,0 +1,22 @@
+#### ANALYSIS OF PRIMER ID SEQUENCING DATA ####
+
+## step 1:
+
+COMMAND: python src/p1_trim_and_filter.py configfile
+
+this will check each read for 5' and 3' primer matches (soft matching via Smith Waterman alignment) and split the reads according to their bar codes. filtered_read.fasta files will be deposited in labeled directories. 
+
+## step 2:
+
+COMMAND: python src/p2_sort.py run_directory read_type
+
+this will split the reads according to their pIDs into a largish number of temporary directories. All pIDs within each directory will be aligned by a cluster job. The parameter read_type specifies whether this is to be done one the filtered or corrected reads. In any case, the script looks for a file named  read_type+"_reads.fasta"
+
+## step 3:
+
+COMMAND: python src/p3_cluster_align.py run_directory
+
+Starts a cluster job for each of the temp directory in each of the barcode directories inside the run_directory. 
+
+
+