annotate tools/ncbi_blast_plus/get_species_taxids.xml @ 33:d999e774072a draft

Fix for get_species_taxids
author peterjc
date Sun, 19 Nov 2023 22:57:39 +0000
parents acf4e47b734c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
30
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
1 <tool id="get_species_taxids" name="NCBI get species taxids" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
2 <description></description>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
3 <macros>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
4 <import>ncbi_macros.xml</import>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
5 </macros>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
6 <expand macro="preamble"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
7 <command detect_errors="aggressive"><![CDATA[
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
8 #if $type_cond.type_sel == 'names'
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
9 #for name in $type_cond.names.split(',')
33
d999e774072a Fix for get_species_taxids
peterjc
parents: 30
diff changeset
10 taxid=\$(get_species_taxids.sh -n '$name' | grep Taxid | sed 's/Taxid\s*:\s*//') &&
d999e774072a Fix for get_species_taxids
peterjc
parents: 30
diff changeset
11 if [ -z "\$taxid" ]; then
30
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
12 >&2 echo "could not find taxid for $name" && exit 1;
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
13 else
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
14 echo " $name -> \$taxid";
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
15 fi &&
33
d999e774072a Fix for get_species_taxids
peterjc
parents: 30
diff changeset
16 get_species_taxids.sh -t "\$taxid" >> species_ids.txt &&
30
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
17 #end for
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
18 #else
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
19 #for taxid in $type_cond.ids.split(',')
33
d999e774072a Fix for get_species_taxids
peterjc
parents: 30
diff changeset
20 get_species_taxids.sh -t "$taxid" >> species_ids.txt &&
30
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
21 #end for
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
22 #end if
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
23 sort -n -u species_ids.txt > '$output'
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
24 ]]></command>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
25 <inputs>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
26 <conditional name="type_cond">
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
27 <param name="type_sel" type="select" label="Get taxids by">
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
28 <option value="names">Taxon names</option>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
29 <option value="ids">Taxon ids</option>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
30 </param>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
31 <when value="names">
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
32 <param name="names" type="text" label="Taxon names" help="comma separated">
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
33 <validator type="regex" message="Enter a comma separated list of taxon names">[a-zA-Z ,]+$</validator>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
34 </param>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
35 </when>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
36 <when value="ids">
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
37 <param name="ids" type="text" label="Taxon ids" help="comma separated">
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
38 <validator type="regex" message="Enter a comma separated list of taxids">[0-9,]+$</validator>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
39 </param>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
40 </when>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
41 </conditional>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
42 </inputs>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
43 <outputs>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
44 <data format="txt" name="output"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
45 </outputs>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
46 <tests>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
47 <test>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
48 <param name="type_cond|type_sel" value="names"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
49 <param name="type_cond|names" value="Enterobacterales"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
50 <output name="output" ftype="txt">
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
51 <assert_contents>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
52 <has_line line="9"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
53 <has_line line="2791989"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
54 </assert_contents>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
55 </output>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
56 </test>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
57 <test>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
58 <param name="type_cond|type_sel" value="ids"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
59 <param name="type_cond|ids" value="91347"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
60 <output name="output" ftype="txt">
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
61 <assert_contents>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
62 <has_line line="9"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
63 <has_line line="2791989"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
64 </assert_contents>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
65 </output>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
66 </test>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
67 <test>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
68 <param name="type_cond|type_sel" value="names"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
69 <param name="type_cond|names" value="Enterobacterales,Hominidae"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
70 <output name="output" ftype="txt">
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
71 <assert_contents>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
72 <has_line line="9"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
73 <has_line line="9606"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
74 <has_line line="2791989"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
75 </assert_contents>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
76 </output>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
77 </test>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
78 <test>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
79 <param name="type_cond|type_sel" value="ids"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
80 <param name="type_cond|ids" value="91347,9604"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
81 <output name="output" ftype="txt">
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
82 <assert_contents>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
83 <has_line line="9"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
84 <has_line line="9606"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
85 <has_line line="2791989"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
86 </assert_contents>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
87 </output>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
88 </test>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
89 </tests>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
90 <help>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
91
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
92 **What it does**
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
93
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
94 Returns a list of species taxids for a taxon. It relies on the get_species_taxids.sh script of the BLAST+ package https://www.ncbi.nlm.nih.gov/books/NBK546209/
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
95
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
96 -------
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
97
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
98 **References**
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
99
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
100 If you use this Galaxy tool in work leading to a scientific publication please
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
101 cite the following papers:
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
102
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
103 @REFERENCES@
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
104 </help>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
105 <expand macro="blast_citations"/>
acf4e47b734c "2.10.1+galaxy1 with taxid improvements"
peterjc
parents:
diff changeset
106 </tool>