annotate artic_guppyplex.xml @ 0:7a82006f7c05 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
author iuc
date Fri, 27 Aug 2021 20:34:52 +0000
parents
children 5ceeb5a5d70f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
1 <tool id="artic_guppyplex" name="ARTIC guppyplex" version="@PACKAGE_VERSION@+galaxy0" profile="20.09">
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
2 <description>Filter Nanopore reads by read length and (optionally) quality</description>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
3 <macros>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
4 <import>macros.xml</import>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
5 </macros>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
6 <requirements>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
7 <requirement type="package" version="@PACKAGE_VERSION@">artic</requirement>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
8 </requirements>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
9 <command detect_errors="exit_code">
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
10 <![CDATA[
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
11 mkdir inputs &&
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
12 #for $i, $elem in enumerate($input)
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
13 ln -fs '$elem' inputs/fastq${i}.fastq &&
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
14 #end for
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
15 artic guppyplex --min-length $min_length --max-length $max_length
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
16 --directory inputs/
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
17 --prefix artic_guppyplex --output '$output1'
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
18 ]]>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
19 </command>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
20 <inputs>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
21 <param name="input" multiple="true" type="data" format="fastq" label="Nanopore reads (FASTQ format" />
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
22 <param name="max_length" type="integer" label="Remove reads longer than" value="700" help="remove reads greater than this number of base pairs" />
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
23 <param name="min_length" type="integer" label="Remove reads shorter than" value="400" help="remove reads less than this number of base pairs" />
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
24 <param name="skip_quality_check" argument="--skip-quality-check" type="boolean" truevalue="--skip-quality-check" falsevalue="" checked="False" label="Do not filter on quality score (speeds up processing)" />
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
25 </inputs>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
26 <outputs>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
27 <data name="output1" format="fastq" from_work_dir="run_name_.fastq" />
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
28 </outputs>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
29 <tests>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
30 <test>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
31 <param name="input" value="test.fastq" />
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
32 <output name="output1" file="gupplyplex_output.fastq"/>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
33 </test>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
34 </tests>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
35 <help><![CDATA[
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
36 The ARTIC_ guppyplex tool filters reads by length and (optionally) quality.
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
37 This filter is typically used as a pre-processing step in the processing
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
38 of amplicon sequencing Nanopore reads, where a size-based filter can
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
39 be used to remove possibly-chimeric reads.
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
40
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
41 The default paramters of the tool (minimum length of 400 and maximum of 700)
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
42 are based on the ARTIC amplicon scheme. If used with a different amplicon
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
43 scheme they should be adjusted to use the minimum length of an amplicon as
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
44 the minimum length and the maximum length of an amplicon plus 200 as the
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
45 maximum length.
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
46
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
47 .. _ARTIC: https://artic.readthedocs.io/en/latest/
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
48 ]]></help>
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
49 <expand macro="citations" />
7a82006f7c05 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/artic commit dacdfa7ecfbdd1c1a12494cf7d0450185c122c84"
iuc
parents:
diff changeset
50 </tool>