annotate crac-index.xml @ 7:87874e4511be draft default tip

Uploaded
author bonsai
date Fri, 13 Sep 2013 10:58:42 -0400
parents 4cf2808854bc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
1 <tool id="crac-index" name="CRAC index">
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
2
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
3 <description>Create genome indexes available to be used with CRAC mapping/annotation tool </description>
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
4
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
5 <command>
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
6 crac-index-wrapper.sh "$output_name" "$output" "$output.files_path" "$bucket" "$input_file"
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
7 </command>
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
8
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
9 <inputs>
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
10 <param name="input_file" type="data" label="Source file" format="fasta" help="You must choose a fasta file containing the genome"/>
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
11 <param name="output_name" type="text" value ="IndexOutput" label="Output name" help="Name must be different from 'index' word, otherwise CRAC-index will fail." />
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
12 <param name="bucket" type="integer" value="100000000" label="Bucket size" help="The size of the bucket for the index construction (default 100000000)."/>
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
13 </inputs>
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
14
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
15 <outputs>
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
16 <data name="output" format="crac_index" label="${output_name}.crac-index" />
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
17 </outputs>
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
18
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
19 <help>
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
20
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
21 **What it does**
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
22
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
23 Crac-index generates an indexed genome from a fasta file. This is especially useful for the Crac mapping/annotation tool.
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
24
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
25 ----------------------
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
26
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
27 **Input Formats**
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
28
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
29 Crac-index takes as input files any fasta or multi-fasta files.
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
30
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
31 ----------------------
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
32
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
33 **Outputs**
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
34
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
35 Crac-index on Galaxy produces a composite output named crac-index, which is made of a ssa file and a conf file. Both are required to the use of your index.
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
36
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
37 ----------------------
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
38
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
39 **Crac-index settings**
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
40
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
41
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
42 Usage : ./crac-index [options] command output_file input_file
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
43
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
44 command must be :
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
45 index: create an index on the specified input file(s).
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
46
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
47 options can be :
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
48
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
49 -b bucket_size the size of the bucket for the index construction
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
50 (default 100000000)
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
51 -d diff-cover parameter for the index construction (default 1024)
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
52 -v verbose mode
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
53
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
54 Examples:
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
55 ./crac-index index myIndex sequence1.fa sequence2.fa sequence3.fa
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
56 You can specify FASTA or MultiFASTA file(s).
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
57 In this example, two files will be created:
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
58 - myIndex.ssa (index storing the compressed sequences)
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
59 - myIndex.conf (information on sequence names and length)
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
60
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
61 </help>
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
62
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
63
4cf2808854bc Uploaded
bonsai
parents:
diff changeset
64 </tool>