Mercurial > repos > iuc > squirrel_qc

annotate squirrel-qc.xml @ 3:4d8ae6baddbe draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/squirrel commit 68ea06281ba78b828b8d1947745161697dc0fbc5
author iuc
date Tue, 10 Jun 2025 13:32:13 +0000
parents 3a11029ea97d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
1 <tool id="squirrel_qc" name="Squirrel QC" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.05">
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
2 <description>QC of MPXV (Mpox virus) sequences</description>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
3 <macros>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
4 <import>macros.xml</import>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
5 </macros>
1
3a11029ea97d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/squirrel commit d684b71bf5129645fe8eb349a56fcb29c321a7ab
iuc
parents: 0
diff changeset
6 <expand macro="xrefs"/>
0
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
7 <expand macro="requirements"/>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
8 <expand macro="version_command"/>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
9
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
11 #set $mask_output = 'input.suggested_mask.csv'
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
12 #set $exclude_output = 'suggested_to_exclude.csv'
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
13
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
14 ln -s '${sequences}' input.fasta &&
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
15
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
16 squirrel
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
17 --seq-qc
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
18 --clade $clade
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
19
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
20 --threads \${GALAXY_SLOTS:-1}
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
21
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
22 input.fasta &&
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
23
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
24 mv '${mask_output}' '$mask' &&
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
25 mv '${exclude_output}' '$exclude'
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
26 ]]></command>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
27
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
28 <inputs>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
29 <param name="sequences"
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
30 type="data"
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
31 format="fasta"
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
32 label="Sequences in FASTA format" />
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
33 <param name="clade"
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
34 type="select"
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
35 label="Select MPXV Clade">
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
36 <option value="cladei">Clade I</option>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
37 <option value="cladeia">Clade Ia</option>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
38 <option value="cladeib">Clade Ib</option>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
39 <option value="cladeii">Clade II</option>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
40 <option value="cladeiia">Clade IIa</option>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
41 <option value="cladeiib">Clade IIb</option>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
42 </param>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
43
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
44 </inputs>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
45
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
46 <outputs>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
47 <!-- standard outputs-->
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
48 <data name="mask" format="csv" label="${tool.name} - flagged mutations to mask" />
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
49 <data name="exclude" format="csv" label="${tool.name} - flagged sequences to exclude" />
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
50 </outputs>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
51
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
52 <tests>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
53 <test expect_num_outputs="2">
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
54 <param name="sequences" value="test-sequences.fasta" />
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
55 <param name="clade" value="cladeii" />
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
56 <output name="mask" file="sequences.suggested_mask.csv" />
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
57 <output name="exclude" file="suggested_to_exclude.csv" />
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
58 </test>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
59 </tests>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
60 <help><![CDATA[
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
61 Squirrel in QC mode can run quality control (QC) on the alignment and flag certain sites to the user that may need to be masked. Squirrel can flag potential issues in the MPXV sequences that have been provided for alignment (e.g. SNPS near tracts of N, clusters of unique SNPs, reversions to reference alleles and convergent mutations) and outputs these in a mask file for investigation.
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
62
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
63 It is recommended that the user looks at these sites in an alignment viewer to judge whether the sites should be masked or not.
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
64
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
65 Squirrel with check within the alignment for:
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
66
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
67 - Mutations that are adjacent to N bases
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
68
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
69 The rationale for this is that N sites are usually a product of low coverage regions. Mutations that occur directly adjacent to low coverage regions may be a result of mis-alignment prior to the low coverage masking and may not be real SNPs. In squirrel, non-majority alleles that are present next to an N are flagged as potential sites for masking
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
70
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
71 - Unique mutations that clump together
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
72
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
73 If mutations are observed in only a single sequence in the genome, they are classed as unique mutations. Usually mutations do not clump closely together and may suggest an alignment or assembly issue. If these mutations are not shared with any other sequences, they are flagged for masking.
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
74
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
75 - Sequences with a high N content
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
76
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
77 Sequences that have many ambiguous bases in them are flagged that they may want to be excluded in further analysis. This may not always be appropriate, often genomes that have a lot of ambiguity can still be informative, however if there is something unusual about a sequence, having lots of ambiguities can be a flag for wider problems (like low read count during assembly).
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
78 ]]></help>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
79 <expand macro="citations"/>
d5699a62c761 planemo upload for repository https://github.com/aineniamh/squirrel commit ed19e40212d1e6651efb3a032d1170f4fd03b989
iuc
parents:
diff changeset
80 </tool>