annotate macros.xml @ 0:a30dd3c77b30 draft

planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
author jjohnson
date Wed, 30 Nov 2016 16:46:40 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
1 <macros>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
2 <xml name="requirements">
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
3 <requirements>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
4 <requirement type="package" version="1.2">samtools</requirement>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
5 <yield/>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
6 </requirements>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
7 </xml>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
8
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
9 <xml name="citations">
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
10 <citations>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
11 <citation type="bibtex">
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
12 @misc{SAM_def,
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
13 title={Definition of SAM/BAM format},
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
14 url = {https://samtools.github.io/hts-specs/SAMv1.pdf},}
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
15 </citation>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
16 <citation type="doi">10.1093/bioinformatics/btp352</citation>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
17 <citation type="doi">10.1093/bioinformatics/btr076</citation>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
18 <citation type="doi">10.1093/bioinformatics/btr509</citation>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
19 <citation type="bibtex">
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
20 @misc{Danecek_et_al,
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
21 Author={Danecek, P., Schiffels, S., Durbin, R.},
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
22 title={Multiallelic calling model in bcftools (-m)},
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
23 url = {http://samtools.github.io/bcftools/call-m.pdf},}
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
24 </citation>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
25 <citation type="bibtex">
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
26 @misc{Durbin_VCQC,
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
27 Author={Durbin, R.},
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
28 title={Segregation based metric for variant call QC},
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
29 url = {http://samtools.github.io/bcftools/rd-SegBias.pdf},}
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
30 </citation>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
31 <citation type="bibtex">
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
32 @misc{Li_SamMath,
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
33 Author={Li, H.},
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
34 title={Mathematical Notes on SAMtools Algorithms},
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
35 url = {http://www.broadinstitute.org/gatk/media/docs/Samtools.pdf},}
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
36 </citation>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
37 <citation type="bibtex">
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
38 @misc{SamTools_github,
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
39 title={SAMTools GitHub page},
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
40 url = {https://github.com/samtools/samtools},}
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
41 </citation>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
42 </citations>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
43 </xml>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
44 <xml name="version_command">
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
45 <version_command>echo $(samtools --version | head -n 1)", "$(samtools --version | grep -o -E "htslib.*?")</version_command>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
46 </xml>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
47 <xml name="stdio">
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
48 <stdio>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
49 <exit_code range="1:" level="fatal" description="Error" />
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
50 </stdio>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
51 </xml>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
52 <token name="@no-chrom-options@">
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
53 -----
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
54
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
55 .. class:: warningmark
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
56
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
57 **No options available? How to re-detect metadata**
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
58
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
59 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:
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
60
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
61 1. Click on the **pencil** icon adjacent to the dataset in the history
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
62 2. A new menu will appear in the center pane of the interface
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
63 3. Click **Datatype** tab
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
64 4. Set **New Type** to **BAM**
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
65 5. Click **Save**
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
66
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
67 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.
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
68
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
69 </token>
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
70
a30dd3c77b30 planemo upload commit 7491208ca0c917a053798a48c3e54c3e30e95d92
jjohnson
parents:
diff changeset
71 </macros>