annotate htseq_count.xml @ 1:cc33706a1d4b draft

update
author mingchen0919
date Tue, 06 Mar 2018 17:38:58 -0500
parents 10a460f61ac2
children db9da9716914
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
mingchen0919
parents: 0
diff changeset
1 <tool id="aurora_htseq" name="Aurora htseq" version="1.0.0">
mingchen0919
parents: 0
diff changeset
2 <description>Counting reads in features.</description>
mingchen0919
parents: 0
diff changeset
3 <requirements>
mingchen0919
parents: 0
diff changeset
4 <requirement type="package" version="1.15.0.6-0">pandoc</requirement>
mingchen0919
parents: 0
diff changeset
5 <requirement type="package" version="1.20.0">r-getopt</requirement>
mingchen0919
parents: 0
diff changeset
6 <requirement type="package" version="1.6">r-rmarkdown</requirement>
mingchen0919
parents: 0
diff changeset
7 <requirement type="package" version="0.9.1">htseq</requirement>
mingchen0919
parents: 0
diff changeset
8 </requirements>
mingchen0919
parents: 0
diff changeset
9 <stdio>
mingchen0919
parents: 0
diff changeset
10 <regex match="XXX" source="stderr" level="warning"
mingchen0919
parents: 0
diff changeset
11 description="Check the warnings_and_errors.txt file for more details."/>
mingchen0919
parents: 0
diff changeset
12 </stdio>
mingchen0919
parents: 0
diff changeset
13 <command><![CDATA[Rscript '${__tool_directory__}/aurora_htseq_count.R'
0
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
14
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
15 -e $echo
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
16 -o $report
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
17 -d $report.files_path
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
18 -s $sink_message
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
19 -t '${__tool_directory__}'
1
mingchen0919
parents: 0
diff changeset
20
mingchen0919
parents: 0
diff changeset
21 -f $format
mingchen0919
parents: 0
diff changeset
22 -r $order
mingchen0919
parents: 0
diff changeset
23 -S $stranded
mingchen0919
parents: 0
diff changeset
24 -a $minaqual
mingchen0919
parents: 0
diff changeset
25 -T $feature_type
mingchen0919
parents: 0
diff changeset
26 -i $idattr
mingchen0919
parents: 0
diff changeset
27 -I $additional_attr
mingchen0919
parents: 0
diff changeset
28 -m $mode]]></command>
mingchen0919
parents: 0
diff changeset
29 <inputs>
mingchen0919
parents: 0
diff changeset
30 <param type="boolean" name="echo" truevalue="TRUE" falsevalue="FALSE" checked="false"
mingchen0919
parents: 0
diff changeset
31 label="Display analysis code in report?"/>
mingchen0919
parents: 0
diff changeset
32 <param type="data" name="alignment_file" label="Alignment file (SAM/BAM)" optional="False" format="sam,bam"/>
mingchen0919
parents: 0
diff changeset
33 <param type="data" name="gff" label="GFF file" optional="False" format="gff, gff3"/>
mingchen0919
parents: 0
diff changeset
34 <param type="select" name="format" argument="-f" label="Input data format" optional="False" multiple="False">
mingchen0919
parents: 0
diff changeset
35 <option value="sam" selected="false">SAM</option>
mingchen0919
parents: 0
diff changeset
36 <option value="bam" selected="false">BAM</option>
mingchen0919
parents: 0
diff changeset
37 </param>
mingchen0919
parents: 0
diff changeset
38 <param type="select" name="order" argument="-r" label="Order"
mingchen0919
parents: 0
diff changeset
39 help="Use this option to indicate how the input data has been sorted. The default is name.&#13;&#10;&#13;&#10;"
mingchen0919
parents: 0
diff changeset
40 optional="False" multiple="False">
mingchen0919
parents: 0
diff changeset
41 <option value="name" selected="false">Name</option>
mingchen0919
parents: 0
diff changeset
42 <option value="pos" selected="false">Position</option>
mingchen0919
parents: 0
diff changeset
43 </param>
mingchen0919
parents: 0
diff changeset
44 <param type="select" name="stranded" argument="-s" label="Stranded" optional="False" multiple="False">
mingchen0919
parents: 0
diff changeset
45 <option value="yes" selected="true">Yes</option>
mingchen0919
parents: 0
diff changeset
46 <option value="no" selected="false">No</option>
mingchen0919
parents: 0
diff changeset
47 <option value="reverse" selected="false">Reverse</option>
mingchen0919
parents: 0
diff changeset
48 </param>
mingchen0919
parents: 0
diff changeset
49 <param type="integer" name="minaqual" argument="-a" label="Alignment quality "
mingchen0919
parents: 0
diff changeset
50 help="Skip all reads with alignment quality lower than the given minimum value (default: 10)"
mingchen0919
parents: 0
diff changeset
51 optional="False" value="10" min="0"/>
mingchen0919
parents: 0
diff changeset
52 <param type="text" name="feature_type" argument="-t" label="Feature type"
mingchen0919
parents: 0
diff changeset
53 help="Feature type (3rd column in GFF file) to be used, all features of other type are ignored (default, suitable for RNA-Seq analysis using an Ensembl GTF file: exon)"
mingchen0919
parents: 0
diff changeset
54 optional="False" value="exon"/>
mingchen0919
parents: 0
diff changeset
55 <param type="text" name="idattr" argument="-i" label="ID attribute"
mingchen0919
parents: 0
diff changeset
56 help="GFF attribute to be used as feature ID. Several GFF lines with the same feature ID will be considered as parts of the same feature. The feature ID is used to identity the counts in the output table. The default, suitable for RNA-Seq analysis using an Ensembl GTF file, is gene_id."
mingchen0919
parents: 0
diff changeset
57 optional="False" value="gene_id"/>
mingchen0919
parents: 0
diff changeset
58 <param type="text" name="additional_attr" argument="--additional-attr" label="Additional attributes"
mingchen0919
parents: 0
diff changeset
59 help="Additional feature attributes, which will be printed as an additional column after the primary attribute column but before the counts column(s). The default is none, a suitable value to get gene names using an Ensembl GTF file is gene_name."
mingchen0919
parents: 0
diff changeset
60 optional="True"/>
mingchen0919
parents: 0
diff changeset
61 <param type="select" name="mode" argument="-m" label="Mode"
mingchen0919
parents: 0
diff changeset
62 help="Mode to handle reads overlapping more than one feature. Possible values for &lt;mode&gt; are union, intersection-strict and intersection-nonempty (default: union)"
mingchen0919
parents: 0
diff changeset
63 optional="False" multiple="False">
mingchen0919
parents: 0
diff changeset
64 <option value="union" selected="true">Union</option>
mingchen0919
parents: 0
diff changeset
65 <option value="intersection-strict" selected="false">Intersection (strict)</option>
mingchen0919
parents: 0
diff changeset
66 <option value="intersection-nonempty" selected="false">Intersection (nonempty)</option>
mingchen0919
parents: 0
diff changeset
67 </param>
mingchen0919
parents: 0
diff changeset
68 </inputs>
mingchen0919
parents: 0
diff changeset
69 <outputs>
mingchen0919
parents: 0
diff changeset
70 <data name="Aurora htseq" format="html" label="Aurora htseq on ${on_string}" hidden="false"/>
mingchen0919
parents: 0
diff changeset
71 <data format="txt" name="sink_message" label="Warnings and Errors" from_work_dir="warnings_and_errors.txt"/>
mingchen0919
parents: 0
diff changeset
72 <data name="count" format="txt" label="Aurora htseq-count on ${on_string}" hidden="false"/>
mingchen0919
parents: 0
diff changeset
73 </outputs>
mingchen0919
parents: 0
diff changeset
74 <citations>
0
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
75 <citation type="bibtex"><![CDATA[
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
76 @article{allaire2016rmarkdown,
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
77 title={rmarkdown: Dynamic Documents for R, 2016},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
78 author={Allaire, J and Cheng, Joe and Xie, Yihui and McPherson, Jonathan and Chang, Winston and Allen, Jeff
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
79 and Wickham, Hadley and Atkins, Aron and Hyndman, Rob},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
80 journal={R package version 0.9},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
81 volume={6},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
82 year={2016}
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
83 }
1
mingchen0919
parents: 0
diff changeset
84 ]]></citation>
mingchen0919
parents: 0
diff changeset
85 <citation type="bibtex"><![CDATA[
0
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
86 @book{xie2015dynamic,
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
87 title={Dynamic Documents with R and knitr},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
88 author={Xie, Yihui},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
89 volume={29},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
90 year={2015},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
91 publisher={CRC Press}
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
92 }
1
mingchen0919
parents: 0
diff changeset
93 ]]></citation>
mingchen0919
parents: 0
diff changeset
94 <citation type="bibtex"><![CDATA[@article{anders2015htseq,
mingchen0919
parents: 0
diff changeset
95 title={HTSeq—a Python framework to work with high-throughput sequencing data},
mingchen0919
parents: 0
diff changeset
96 author={Anders, Simon and Pyl, Paul Theodor and Huber, Wolfgang},
mingchen0919
parents: 0
diff changeset
97 journal={Bioinformatics},
mingchen0919
parents: 0
diff changeset
98 volume={31},
mingchen0919
parents: 0
diff changeset
99 number={2},
mingchen0919
parents: 0
diff changeset
100 pages={166--169},
mingchen0919
parents: 0
diff changeset
101 year={2015},
mingchen0919
parents: 0
diff changeset
102 publisher={Oxford University Press}
mingchen0919
parents: 0
diff changeset
103 }]]></citation>
mingchen0919
parents: 0
diff changeset
104 </citations>
0
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
105 </tool>