annotate kmer_analysis.xml @ 19:385fc64fa988 draft default tip

Uploaded
author rlegendre
date Fri, 12 Jun 2015 11:32:59 -0400
parents 7c944fd9907e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
1 <tool id="kmer_analysis" name="Kmer">
11
rlegendre
parents: 3
diff changeset
2 <description>To calculate the proportion and phasing of each kmer</description>
3
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
3 <requirements>
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
4 <requirement type="package">samtools</requirement>
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
5 <requirement type="package">numpy</requirement>
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
6 <requirement type="package">matplotlib</requirement>
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
7 <requirement type="package">pysam</requirement>
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
8 </requirements>
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
9 <command interpreter="python">
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
10 kmer_analysis.py --gff $gff --bam $bamfile --dirout $output.files_path --out $output
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
11
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
12 </command>
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
13
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
14 <inputs>
11
rlegendre
parents: 3
diff changeset
15 <param name="gff" type="data" label="Reference annotation file (GFF))" format="gff" />
3
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
16 <param name="bamfile" type="data" label="Bam file" format="bam" />
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
17 </inputs>
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
18
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
19 <outputs>
13
7c944fd9907e release 2
rlegendre
parents: 11
diff changeset
20 <data format="html" name="output" label="Kmer report on ${on_string}"/>
3
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
21
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
22 </outputs>
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
23
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
24 <help>
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
25
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
26 Summary
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
27 -------
13
7c944fd9907e release 2
rlegendre
parents: 11
diff changeset
28 The kmer tool computes the distribution of footprints length from Bam file and determines the proportion of footprints beginning in each frame, for all annotated genes in the `GFF3`_ file.
7c944fd9907e release 2
rlegendre
parents: 11
diff changeset
29
3
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
30
13
7c944fd9907e release 2
rlegendre
parents: 11
diff changeset
31 .. _GFF3: http://gmod.org/wiki/GFF3
7c944fd9907e release 2
rlegendre
parents: 11
diff changeset
32
3
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
33 Output
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
34 -------
11
rlegendre
parents: 3
diff changeset
35 This tool provides an html report detailing the proportions and phasing of the kmers.
3
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
36
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
37
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
38 Dependances
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
39 ------------
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
40
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
41 .. class:: warningmark
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
42
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
43 This tool depends on Python (>=2.7) and following packages : numpy 1.8.0 and matplotlib 1.3.1. Samtools and pysam are used for bam manipulation.
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
44
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
45 </help>
8d8552899d20 Uploaded
rlegendre
parents:
diff changeset
46 </tool>