annotate genap2_kb_python/kb_count.xml @ 3:1ecec9b9dde7 draft default tip

Uploaded
author fwuennemann
date Sat, 01 May 2021 16:20:44 +0000
parents 4da457a2c5dc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
1ecec9b9dde7 Uploaded
fwuennemann
parents: 2
diff changeset
1 <tool id="kb_python" name="kb_python" version="@VERSION@+galaxy2">
0
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
2 <description>performs gene and feature quantification on single-cell sequencing data.</description>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
3 <macros>
2
4da457a2c5dc Uploaded
fwuennemann
parents: 1
diff changeset
4 <import>macros.xml</import>
4da457a2c5dc Uploaded
fwuennemann
parents: 1
diff changeset
5 </macros>
4da457a2c5dc Uploaded
fwuennemann
parents: 1
diff changeset
6 <requirements>
4da457a2c5dc Uploaded
fwuennemann
parents: 1
diff changeset
7 <requirement type="package" version="@VERSION@" >kb-python</requirement>
4da457a2c5dc Uploaded
fwuennemann
parents: 1
diff changeset
8 <requirement type="package" version="1.0.0">jupyter</requirement>
4da457a2c5dc Uploaded
fwuennemann
parents: 1
diff changeset
9 </requirements>
4da457a2c5dc Uploaded
fwuennemann
parents: 1
diff changeset
10
0
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
11 <stdio>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
12 <exit_code range="1:" />
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
13 <exit_code range=":-1" />
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
14 <regex match="Error:" />
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
15 <regex match="Exception:" />
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
16 <regex match="Exception :" />
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
17 </stdio>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
18 <command detect_errors="exit_code"><![CDATA[
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
19 mkdir ./index
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
20 && mkdir ./kb_outs
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
21 #if $refTranscriptSource.TranscriptSource == "history":
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
22 && ln -s '${refTranscriptSource.h_index.index_file}' './index/kb_ref.idx'
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
23 && ln -s '${refTranscriptSource.h_index.t2g_file}' './index/t2g.txt'
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
24 #if $workflow == "lamanno" or $workflow == "nucleus":
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
25 && ln -s '${refTranscriptSource.h_index.history_lamanno.cdna_t2c}' './index/cdna_t2c.txt'
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
26 && ln -s '${refTranscriptSource.h_index.history_lamanno.intron_t2c}' './index/intron_t2c.txt'
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
27 #end if
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
28 #set $index_path = './index'
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
29 #else if $refTranscriptSource.TranscriptSource == "built":
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
30 && kb ref -i ./index/kb_ref.idx
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
31 -g ./index/t2g.txt
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
32 -f1 ./index/cdna.fa
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
33 --workflow $workflow
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
34 #if $workflow == "lamanno" or $workflow == "nucleus":
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
35 -f2 ./index/intron.fa
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
36 -c1 ./index/cdna_t2c.txt
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
37 -c2 ./index/intron_t2c.txt
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
38 --workflow $workflow
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
39 #end if
3
1ecec9b9dde7 Uploaded
fwuennemann
parents: 2
diff changeset
40 #if $workflow != "kite" and $workflow != "kite:10xFB":
0
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
41 '${refTranscriptSource.s_index.genomic_fasta}'
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
42 '${refTranscriptSource.s_index.genomic_gtf}'
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
43 #else:
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
44 '${refTranscriptSource.s_index.kite_table}'
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
45 #end if
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
46 #set $index_path = './index'
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
47 #end if
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
48 && kb count
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
49 -t \${GALAXY_SLOTS:-1}
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
50 -i $index_path/kb_ref.idx
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
51 -g $index_path/t2g.txt
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
52 #if $workflow == "lamanno" or $workflow == "nucleus":
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
53 -c1 $index_path/cdna_t2c.txt
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
54 -c2 $index_path/intron_t2c.txt
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
55 #end if
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
56 -x $technology
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
57 #if $whitelist:
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
58 --whitelist '${optional.whitelist}'
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
59 #end if
1
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
60 ${optional.multimap}
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
61 ${optional.report}
0
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
62 --workflow $workflow
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
63 #if $extra_dtype != "none":
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
64 $extra_dtype
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
65 #end if
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
66 -o ./kb_outs
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
67 --cellranger
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
68 $FASTQ1
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
69 $FASTQ2
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
70 ]]>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
71 </command>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
72 <inputs>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
73 <param name="workflow" label="Select the workflow you want to use:" type="select" multiple="false" format="text" help="Type of workflow. Use `lamanno` for RNA velocity based on La Manno et al. 2018 logic.
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
74 Use `nucleus` for RNA velocity on single-nucleus RNA-seq reads. Use `kite` for feature barcoding. Use `kite:10xFB` for 10x Genomics Feature Barcoding technology.">
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
75 <option value="standard">standard</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
76 <option value="lamanno">lamanno</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
77 <option value="nucleus">nucleus</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
78 <option value="kite">kite</option>
3
1ecec9b9dde7 Uploaded
fwuennemann
parents: 2
diff changeset
79 <option value="kite:10xFB">kite:10xFB (CITe-seq with Feature barcoding)</option>
0
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
80 </param>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
81 <expand macro="index"/>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
82 <param name="technology" label="Select the scRNA-seq technology:" type="select" multiple="false" format="text" help="Choose the scRNA-seq technology used to generate the fastq data.">
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
83 <option value="10XV1">10XV1</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
84 <option value="10XV2">10XV2</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
85 <option value="10XV3">10XV3</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
86 <option value="CELSEQ">CELSEQ</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
87 <option value="CELSEQ2">CELSEQ2</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
88 <option value="DROPSEQ">DROPSEQ</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
89 <option value="INDROPSV1">INDROPSV1</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
90 <option value="INDROPSV2">INDROPSV2</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
91 <option value="INDROPSV3">INDROPSV3</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
92 <option value="SCRUBSEQ">SCRUBSEQ</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
93 <option value="SURECELL">SURECELL</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
94 </param>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
95 <param name="FASTQ1" label="Select the R1 fastq file:" type="data" format="fastqsanger.gz" multiple="false"/>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
96 <param name="FASTQ2" label="Select the R2 fastq file:" type="data" format="fastqsanger.gz" multiple="false"/>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
97 <param name="extra_dtype" type="select" label="Do you want any additional output data type beside CellRanger?">
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
98 <option value="none" selected = "true">No</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
99 <option value="--loom">Loom</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
100 <option value="--h5ad">H5ad</option>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
101 </param>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
102 <section name="optional" title="Optional commands" expanded="false">
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
103 <param name="whitelist" type="data" format="tsv,tabular" optional="true" label="Whitelist file" help="Whitelisted barcodes to correct to. If not provided and bustools supports the technology, a pre-packaged whitelist is used. If not, the bustools
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
104 whitelist command is used."/>
1
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
105 <param name="multimap" type="boolean" optional="true" truevalue="--mm" falsevalue="" label="Include multi pseudoaligned reads?" help="Do you want to include reads that pseudoalign to multiple genes?"/>
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
106 <param name="report" type="boolean" optional="true" truevalue="--report" falsevalue="" label="Create an html report?" help="If true, will create an html report with mapping statistics and cell" checked="false"/>
0
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
107 </section>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
108 </inputs>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
109 <outputs>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
110 <data name="barcodes" label="cellranger barcodes" format="txt" from_work_dir="kb_outs/counts_unfiltered/cellranger/barcodes.tsv"/>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
111 <data name="genes" label="cellranger genes" format="txt" from_work_dir="kb_outs/counts_unfiltered/cellranger/genes.tsv"/>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
112 <data name="matrix" label="cellranger matrix" format="mtx" from_work_dir="kb_outs/counts_unfiltered/cellranger/matrix.mtx" />
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
113 <data name="inspect" label="inspect_report" format="json" from_work_dir="kb_outs/inspect.json"/>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
114 <data name="runinfo" label="run info" format="json" from_work_dir="kb_outs/run_info.json"/>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
115 <data name="kbinfo" label="kb info" format="json" from_work_dir="kb_outs/kb_info.json"/>
1
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
116 <data name="kb_ref" label="kb_ref.idx" format="kallisto.idx" from_work_dir="index/kb_ref.idx">
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
117 <filter>refTranscriptSource['TranscriptSource'] == "built"</filter>
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
118 </data>
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
119 <data name="t2g" label="t2g.txt" format="txt" from_work_dir="index/t2g.txt">
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
120 <filter>refTranscriptSource['TranscriptSource'] == "built"</filter>
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
121 </data>
0
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
122 <data name="cdna_t2c" label="-c1 cdna_t2c.txt" format="txt" from_work_dir="index/cdna_t2c.txt">
1
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
123 <filter>refTranscriptSource['TranscriptSource'] == "built"</filter>
0
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
124 <filter>workflow == "lamanno"</filter>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
125 </data>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
126 <data name="intron_t2c" label="-c2 intron_t2c.txt" format="txt" from_work_dir="index/intron_t2c.txt">
1
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
127 <filter>refTranscriptSource['TranscriptSource'] == "built"</filter>
0
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
128 <filter>workflow == "lamanno"</filter>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
129 </data>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
130 <data name="adata" label="adata.h5ad" format="h5ad" from_work_dir="kb_outs/counts_unfiltered/adata.h5ad">
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
131 <filter >extra_dtype == "--h5ad"</filter>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
132 </data>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
133 <data name="adata" label="adata.loom" format="loom" from_work_dir="kb_outs/counts_unfiltered/adata.loom">
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
134 <filter>extra_dtype == "--loom"</filter>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
135 </data>
1
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
136 <data name="report" label="report.html" format="html" from_work_dir="kb_outs/report.html">
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
137 <filter>optional["report"]</filter>
dbcb26e2a1db Updated tool version
fwuennemann
parents: 0
diff changeset
138 </data>
0
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
139 </outputs>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
140 <tests>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
141 <expand macro="tests"/>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
142 </tests>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
143 <help><![CDATA[
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
144 This is a galaxy wrapper for kallisto-bustools (kb) for quantification of different types of single-cell sequencing data. The main kallisto-bustools homepage can be found under:
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
145 'kallisto-bustools<https://www.kallistobus.tools/>'.
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
146
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
147 The kb count command runs the kallisto and bustools programs. It can be used for pre-processing of data from a variety of single-cell RNA-seq technologies,
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
148 and for a number of different workflows (e.g. production of gene count matrices, RNA velocity analyses, etc.).
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
149
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
150 The kb package is developed and maintained by the Pachterlab under the MIT License.
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
151 ]]></help>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
152 <citations>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
153 <citation type="doi">https://doi.org/10.1101/673285</citation>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
154 </citations>
e8d93f1429c2 Uploaded
fwuennemann
parents:
diff changeset
155 </tool>