annotate sinto_barcode.xml @ 0:3456ec59ff7a draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
author iuc
date Thu, 13 Apr 2023 11:03:17 +0000
parents
children f1d83e3a2357
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
1 <tool id="sinto_barcode" name="Sinto barcode" profile="20.01" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@">
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
2 <description>add cell barcodes to FASTQ read names</description>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
3 <macros>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
4 <import>macros.xml</import>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
5 </macros>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
6 <requirements>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
7 <requirement type="package" version="@TOOL_VERSION@">sinto</requirement>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
8 </requirements>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
9 <version_command>sinto --version</version_command>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
10 <command><![CDATA[
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
11 ln -s '$barcode_fastq' barcodes.fastq.gz &&
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
12 ln -s '${fastq_input.read1_fastq}' read1.fastq.gz &&
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
13 #if str( $fastq_input.fastq_input_selector ) == "paired":
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
14 ln -s '${fastq_input.read2_fastq}' read2.fastq.gz &&
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
15 #end if
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
16 sinto barcode
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
17 --barcode_fastq barcodes.fastq.gz
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
18 --read1 read1.fastq.gz
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
19 #if str( $fastq_input.fastq_input_selector ) == "paired":
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
20 --read2 read2.fastq.gz
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
21 #end if
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
22 --bases $bases
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
23 ]]> </command>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
24 <inputs>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
25 <param type="data" name="barcode_fastq" format="fastqsanger.gz" label="FASTQ file containing cell barcode sequences" />
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
26 <conditional name="fastq_input">
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
27 <param name="fastq_input_selector" type="select" label="Single or Paired-end data">
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
28 <option value="paired">Paired</option>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
29 <option value="single">Single</option>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
30 </param>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
31 <when value="paired">
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
32 <param name="read1_fastq" type="data" format="fastqsanger.gz" label="Forward reads FASTQ file" />
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
33 <param name="read2_fastq" type="data" format="fastqsanger.gz" label="Reverse reads FASTQ file" />
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
34 </when>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
35 <when value="single">
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
36 <param name="read1_fastq" type="data" format="fastqsanger.gz" label="Select FASTQ file" />
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
37 </when>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
38 </conditional>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
39 <param type="integer" name="bases" value="16" min="0" label="Number of bases to extract from barcode-containing FASTQ" />
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
40 </inputs>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
41 <outputs>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
42 <data name='read1_out' format='fastqsanger.gz' label="${tool.name} on ${on_string}: barcoded read 1" from_work_dir="read1.barcoded.fastq" />
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
43 <data name='read2_out' format='fastqsanger.gz' label="${tool.name} on ${on_string}: barcoded read 2" from_work_dir="read2.barcoded.fastq" >
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
44 <filter>fastq_input['fastq_input_selector'] == 'paired'</filter>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
45 </data>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
46 </outputs>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
47 <tests>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
48 <test expect_num_outputs="1">
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
49 <param name="barcode_fastq" value="barcodes.fastq.gz" />
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
50 <param name="fastq_input_selector" value="single"/>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
51 <param name="read1_fastq" value="read1.fastq.gz" />
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
52 <output name="read1_out" file="read1.barcoded.fastq.gz" ftype="fastqsanger.gz" decompress="true" />
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
53 </test>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
54 <test expect_num_outputs="2">
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
55 <param name="barcode_fastq" value="barcodes.fastq.gz" />
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
56 <param name="fastq_input_selector" value="paired"/>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
57 <param name="read1_fastq" value="read1.fastq.gz" />
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
58 <param name="read2_fastq" value="read2.fastq.gz" />
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
59 <output name="read1_out" file="read1.barcoded.fastq.gz" ftype="fastqsanger.gz" decompress="true"/>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
60 <output name="read2_out" file="read2.barcoded.fastq.gz" ftype="fastqsanger.gz" decompress="true"/>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
61 </test>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
62 </tests>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
63 <help><![CDATA[
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
64
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
65 Sinto is a toolkit for processing aligned single-cell data.
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
66 --------------------------------------------------------------------------------------------------------------
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
67 Cell barcodes from one FASTQ file added to the read names of another, or the same, FASTQ file. This is useful when processing raw single-cell sequencing data, as the cell barcode information can easily be propagated to the aligned BAM file by encoding the cell barcode in the read name.
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
68
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
69 **Inputs**
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
70 FASTQ files containing barcodes and forward reads. An optional reverse reads FASTQ file can be provided for paired-end experiments. Note that all the FASTQs must contain the same number of reads and the reads must appear in the same order.
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
71
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
72 **Outputs**
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
73 FASTQ files with the read names modified to contain the cell barcode sequence at the beginning of the read name, separated from the original read name by a : character.
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
74
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
75 ]]> </help>
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
76 <expand macro="citations" />
3456ec59ff7a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sinto commit a836e4e010093207186d4d7839bbba702a15c18f
iuc
parents:
diff changeset
77 </tool>