annotate freyja_variants.xml @ 1:1f467ed22412 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 26266f43c51f3f711ecd3a7dc6aea581a3b57fc5
author iuc
date Fri, 07 Jul 2023 05:50:46 +0000
parents 08c2d81e7942
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
1 <tool id="freyja_variants" name="Freyja: Call variants"
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
2 version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@"
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
3 profile="@PROFILE@">
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
4 <description>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
5 and get sequencing depth information
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
6 </description>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
7 <macros>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
8 <import>macros.xml</import>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
9 </macros>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
10 <expand macro="biotools"/>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
11 <expand macro="requirements"/>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
12 <expand macro="version"/>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
13 <command detect_errors="exit_code"><![CDATA[
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
14 ln -s '$bam_file' 'bam_file' &&
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
15 ln -s '$ref_file' 'ref_file' &&
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
16 freyja variants
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
17 'bam_file'
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
18 --variants variants
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
19 --depths '$depths'
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
20 --ref 'ref_file'
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
21 ]]></command>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
22 <inputs>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
23 <param name="bam_file" type="data" format="bam" label="BAM file"
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
24 help="After primer trimming and alignment to reference genome."/>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
25 <param name="ref_file" argument="--ref" type="data" format="fasta"
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
26 label="Reference sequence file"
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
27 help="Note that the reference should match the fasta file used for alignment."/>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
28 </inputs>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
29 <outputs>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
30 <data name="variants" format="tabular" label="${tool.name} on ${on_string}: Variant call"
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
31 from_work_dir="variants.tsv">
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
32 </data>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
33 <data name="depths" format="tabular" label="${tool.name} on ${on_string}: Sequencing depth"
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
34 from_work_dir="depths.tsv">
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
35 </data>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
36 </outputs>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
37 <tests>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
38 <test expect_num_outputs="2">
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
39 <param name="bam_file" value="test.bam"/>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
40 <param name="ref_file" value="NC_045512_Hu-1.fasta"/>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
41 <output name="variants" ftype="tabular">
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
42 <assert_contents>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
43 <has_text text="REF_CODON"/>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
44 <has_text text="NC_045512.2"/>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
45 </assert_contents>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
46 </output>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
47 <output name="depths" ftype="tabular">
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
48 <assert_contents>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
49 <has_text text="NC_045512.2"/>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
50 </assert_contents>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
51 </output>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
52 </test>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
53 </tests>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
54 <help><![CDATA[
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
55 @HELP_HEADER@
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
56
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
57 Information about **freyja variants** method
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
58 ============================================
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
59
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
60 The method uses both samtools and iVar.
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
61
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
62 .. class:: warningmark
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
63
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
64 Note that the reference should match the fasta file used for alignment.
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
65
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
66 Outputs
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
67 =======
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
68
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
69 We get both variant call and sequencing depth information with this command.
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
70
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
71 ]]></help>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
72 <expand macro="citations"/>
08c2d81e7942 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freyja commit 2036e233d159a5c4b3b06ce6a681531259098f73
iuc
parents:
diff changeset
73 </tool>