comparison README.md @ 0:14fd6f3b0898 draft

planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/extract_sequence_file/ commit ffb68b2ddd94854a34a2533105f7bc08884c6e38-dirty
author bebatut
date Wed, 27 Jan 2016 02:50:51 -0500
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:14fd6f3b0898
1 Extract from sequence file
2 ==========================
3
4 This tool is developped to extract from sequence file. Different treatments are possible.
5 Specific sequences could be extracted given some constraints and they could be saved in a sequence file.
6 Some information about the sequences such as the identifiant or the length could be extracted and saved in
7 a text file. Fastq file could also be split into a sequence file and a quality file.
8
9 # Usage
10
11 ```
12 python extract_sequence_file.py \
13 --input input_sequence_filepath \
14 --format fastq/fasta
15 --custom_extraction_type yes/no \
16 [--output_sequence output_sequence_filepath if custom_extraction_type = no] \
17 [--output_information information_filepath if custom_extraction_type = yes] \
18 [--to_extract "{info_to_extract,info_to_extract}" if custom_extraction_type = yes] \
19 [--split yes/no if format=fastq] \
20 [--output_quality output_quality_filepath if split=yes] \
21 [--quality_format sanger/solexa/illumina_1_3/illumina_1_5/illumina_1_8 if split=yes] \
22 --report report_filepath \
23 [--constraint info_to_constrain: type_of_constraint: value_of_constraint ]
24 ```
25 # Formats
26
27 Formats for sequence file:
28
29 - fasta
30 - fastq
31
32 Formats for quality scores:
33
34 - sanger
35 - solexa
36 - illumina_1_3
37 - illumina_1_5
38 - illumina_1_8
39
40 # Functional tests
41
42 Some functional tests are implemented tot est the major treatments. To launch functional tests:
43
44 ```
45 test-data/src/run_tests.sh
46 ```