annotate chira_quantify.xml @ 4:903f7a4cfbf0 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit aafb8e5de9023eeddd7f4683909f418ef5aae086"
author iuc
date Fri, 20 Mar 2020 04:58:19 -0400
parents 2b150f2a012b
children e40017f9cff1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
1 <tool id="chira_quantify" name="ChiRA qauntify" version="@WRAPPER_VERSION@0">
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
2 <description>quantify aligned loci to score the alignments</description>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
3 <macros>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
4 <import>macros.xml</import>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
5 </macros>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
6 <expand macro="requirements" />
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
7 <command><![CDATA[
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
8 chira_quantify.py
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
9 -b '$segments'
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
10 -m '$merged'
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
11 -cs '$crl_share'
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
12 -ls '$min_locus_size'
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
13 -e '$em_threshold'
1
2b150f2a012b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit 6845f3b028a42acbefb07c5f59fd2e558f50a768"
iuc
parents: 0
diff changeset
14 $crl
0
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
15 -o ./
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
16 ]]></command>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
17
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
18 <inputs>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
19 <param format="bed" name="segments" type="data" label="BED file of aligned segments"/>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
20 <param format="tabular" name="merged" type="data" label="Tabular file of merged alignments"/>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
21 <param name="crl_share" type="float" value="0.7" label="CRL locus fraction" min="0" max="1"
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
22 help="Minimum fraction of reads of a locus that must overlap with all CRL loci inorder to merge itinto that CRL."/>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
23 <param name="min_locus_size" type="integer" value="5" label="Minimum locus size" min="1"
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
24 help="Minimum number of reads a locus should have in order to participate in CRL creation.
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
25 Always set this value relative to your sequencing depth. Setting this to lower leads
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
26 CRLs of random multimappings Also consider setting the --crl_share option
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
27 along with this"/>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
28 <param name="em_threshold" type="float" value="1" label="EM threshold"
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
29 help="The maximum difference of transcripts expression between two consecutive iterations of EM algorithm to converge."/>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
30 <param name="crl" type="boolean" truevalue="-crl" falsevalue="" checked="true"
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
31 label="Create CRLs" help="Create CRLs and qunatify them or use the loci further without creating the CRLs" />
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
32 </inputs>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
33 <outputs>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
34 <data format="tabular" name="loci" from_work_dir="loci.counts" label="ChiRA quantified loci on ${on_string}"/>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
35 </outputs>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
36
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
37 <tests>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
38 <test expect_num_outputs="1">
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
39 <param name="segments" value="segments.bed"/>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
40 <param name="merged" value="merged.bed"/>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
41 <output name="loci" file="loci.counts"/>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
42 </test>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
43 </tests>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
44
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
45 <help>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
46
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
47 .. class:: infomark
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
48
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
49 **What it does**
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
50
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
51 This tool first creates CRLS from merged BED file and quantifies them based on the mapped reads.
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
52
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
53 **Inputs**
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
54
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
55 * A BED file containing alignment segments
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
56 * A BED file containing merged alignments
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
57
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
58 **Output**
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
59
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
60 * Tabular file containing the reads and their CRLs with TPM values.
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
61
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
62 </help>
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
63 <expand macro="citations" />
1bfa8c091530 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/chira commit e4f841daf49048d6c656d50cffb344b53eebeec2"
iuc
parents:
diff changeset
64 </tool>