Skip to content

Commit f821484

Browse files
committed
Updated the docs to include Illumina data.
1 parent 20fcd39 commit f821484

1 file changed

Lines changed: 16 additions & 3 deletions

File tree

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ available on any \*nix machine you have access to but don't have root access.)
9797
4. Generate pre-configured entries for all of the above ready to be copied &
9898
pasted into 4Pipe4rc.
9999

100-
These scripts should significantlly speed up the instalation process of these
100+
These scripts should significantly speed up the installation process of these
101101
external 4Pipe4 programs.
102102

103103
By default these scripts will install all the software to "~/Software", but this
@@ -116,7 +116,7 @@ usage: 4Pipe4 [-h] -i sff_file -o basefile [-c configfile] [-s [RUN_LIST]]
116116
117117
optional arguments:
118118
-h, --help show this help message and exit
119-
-i sff_file Provide the full path to your target sff file
119+
-i input_file Provide the full path to your target input file
120120
-o basefile Provide the full path to your results directory, plus the name you want to give your results
121121
-c configfile Provide the full path to your configuration file. If none is provided, the program will look in the current working directory and then in ~/.config/4Pipe4rc (in this order) for one. If none is found the program will stop
122122
-s [RUN_LIST] Specify the numbers corresponding to the pipeline steps that will be run. The string after -s must be given inside quotation marks, and numbers can be joined together or separated by any symbol. The numbers are the pipeline steps that should be run. This is an optional argument and it's omission will run all steps by default'. The numbers, from 1 to 9 represent the following steps:
@@ -130,17 +130,28 @@ optional arguments:
130130
8 - SSR finder
131131
9 - 7zip the report
132132
133+
-d 454/solexa Declare the type of data being used. Currentlly suported are 454 (454) and Illumina (solexa). Default is 454.
134+
-p [True/False] Is the data paired end? True/False, default is False.
135+
133136
The idea here is that to resume an analysis that was interrupted for example after the assembling process you should issue -s '4,5,6,7,8,9' or -s '456789'. Note that some steps depend on the output of previous steps, so using some combinations can cause errors. The arguments can be given in any order.
134137
```
135138

136139
--------------------------------------------
137140

138-
If you wish to run the entire pipeline, just issue something like
141+
If you wish to run the entire pipeline on 454 data, just issue something like
139142

140143
```
141144
python3 4Pipe4.py -i /path/to/file.sff -o /path/to/results/basefilename
142145
```
143146

147+
However, if you wish to run the pipeline with Illumina data, skip steps 1 and 2,
148+
and add the "-d solexa" switch:
149+
150+
```
151+
python3 4Pipe4.py -i /path/to/reads.fastq -o /path/to/results/basefilename\
152+
-d solexa -s 3,4,5,6,7,8,9
153+
```
154+
144155
Use the -s option to specify only the steps you wish to run from the analysis
145156
and the -c option to point 4Pipe4 to a specific configuration file.
146157

@@ -151,6 +162,8 @@ purposes, as well as documentation on how to do an example run of 4Pipe4.
151162

152163
The configuration file contains information on every option. You should change
153164
those options to reflect your own system and SNP detection preferences.
165+
Do not forget that the helper scripts will generate most of the config file
166+
for you if you wish.
154167

155168
### CONTACT
156169

0 commit comments

Comments
 (0)