annotate macros.xml @ 4:3bade5114f21 draft

planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
author devteam
date Tue, 13 Oct 2015 12:53:40 -0400
parents
children 4ffbc8cedb42
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
1 <macros>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
2 <xml name="requirements">
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
3 <requirements>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
4 <requirement type="package" version="1.2">samtools</requirement>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
5 <yield/>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
6 </requirements>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
7 </xml>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
8 <xml name="citations">
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
9 <citations>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
10 <citation type="bibtex">
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
11 @misc{SAM_def,
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
12 title={Definition of SAM/BAM format},
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
13 url = {https://samtools.github.io/hts-specs/SAMv1.pdf},}
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
14 </citation>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
15 <citation type="doi">10.1093/bioinformatics/btp352</citation>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
16 <citation type="doi">10.1093/bioinformatics/btr076</citation>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
17 <citation type="doi">10.1093/bioinformatics/btr509</citation>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
18 <citation type="bibtex">
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
19 @misc{Danecek_et_al,
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
20 Author={Danecek, P., Schiffels, S., Durbin, R.},
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
21 title={Multiallelic calling model in bcftools (-m)},
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
22 url = {http://samtools.github.io/bcftools/call-m.pdf},}
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
23 </citation>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
24 <citation type="bibtex">
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
25 @misc{Durbin_VCQC,
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
26 Author={Durbin, R.},
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
27 title={Segregation based metric for variant call QC},
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
28 url = {http://samtools.github.io/bcftools/rd-SegBias.pdf},}
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
29 </citation>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
30 <citation type="bibtex">
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
31 @misc{Li_SamMath,
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
32 Author={Li, H.},
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
33 title={Mathematical Notes on SAMtools Algorithms},
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
34 url = {http://www.broadinstitute.org/gatk/media/docs/Samtools.pdf},}
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
35 </citation>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
36 <citation type="bibtex">
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
37 @misc{SamTools_github,
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
38 title={SAMTools GitHub page},
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
39 url = {https://github.com/samtools/samtools},}
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
40 </citation>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
41 </citations>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
42 </xml>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
43 <xml name="version_command">
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
44 <version_command>samtools --version | head -n 1 | awk '{ print $2 }'</version_command>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
45 </xml>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
46 <xml name="stdio">
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
47 <stdio>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
48 <exit_code range="1:" level="fatal" description="Error" />
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
49 </stdio>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
50 </xml>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
51 <token name="@no-chrom-options@">
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
52 -----
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
53
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
54 .. class:: warningmark
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
55
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
56 **No options available? How to re-detect metadata**
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
57
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
58 If you see a &quot;No options available&quot; within the &quot;**Select references (chromosomes and contigs) you would like to restrict bam to**&quot; drop down, you need to re-detect metadata for the dataset you are trying to process. To do this follow these steps:
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
59
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
60 1. Click on the **pencil** icon adjacent to the dataset in the history
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
61 2. A new menu will appear in the center pane of the interface
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
62 3. Click **Datatype** tab
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
63 4. Set **New Type** to **BAM**
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
64 5. Click **Save**
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
65
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
66 The medatada will be re-detected and you will be able to see the list of reference sequences in the &quot;**Select references (chromosomes and contigs) you would like to restrict bam to**&quot; drop-down.
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
67
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
68 </token>
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
69
3bade5114f21 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents:
diff changeset
70 </macros>