annotate htseq_count.xml @ 6:7c54fd452b8e draft

add kableExtra package
author mingchen0919
date Wed, 18 Apr 2018 15:59:38 -0400
parents aacd5f53ac99
children 63cde8d7f89c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
mingchen0919
parents: 4
diff changeset
1 <tool id="aurora_htseq" name="aurora_htseq" version="2.0.0">
4
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
2 <description>Counting reads in features.</description>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
3 <requirements>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
4 <requirement type="package" version="1.15.0.6-0">pandoc</requirement>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
5 <requirement type="package" version="1.20.0">r-getopt</requirement>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
6 <requirement type="package" version="1.6">r-rmarkdown</requirement>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
7 <requirement type="package" version="0.9.1">htseq</requirement>
6
7c54fd452b8e add kableExtra package
mingchen0919
parents: 5
diff changeset
8 <requirement type="package" version="0.8.0">r-kableextra</requirement>
4
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
9 </requirements>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
10 <stdio>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
11 <regex match="XXX" source="stderr" level="warning"
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
12 description="Check the warnings_and_errors.txt file for more details."/>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
13 </stdio>
5
mingchen0919
parents: 4
diff changeset
14 <command><![CDATA[
mingchen0919
parents: 4
diff changeset
15
mingchen0919
parents: 4
diff changeset
16 ######### each aurora tool generates a html file and have an files path directory associated with it.
mingchen0919
parents: 4
diff changeset
17 mkdir -p $report.files_path &&
0
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
18
5
mingchen0919
parents: 4
diff changeset
19 ######### three important paths:
mingchen0919
parents: 4
diff changeset
20 ######### 1. path to tool installation directory
mingchen0919
parents: 4
diff changeset
21 ######### 2. path to report html
mingchen0919
parents: 4
diff changeset
22 ######### 3. path to files_path directory associated with the report output.
mingchen0919
parents: 4
diff changeset
23 export TOOL_INSTALL_DIR='${__tool_directory__}' &&
mingchen0919
parents: 4
diff changeset
24 export REPORT='$report' &&
mingchen0919
parents: 4
diff changeset
25 export REPORT_FILES_PATH='$report.files_path' &&
mingchen0919
parents: 4
diff changeset
26
mingchen0919
parents: 4
diff changeset
27 ############ create a hidden file to store r markdown rendering log
mingchen0919
parents: 4
diff changeset
28 echo '------ Rmd rendering log -------\n' > $report.files_path/.r_rendering.log.txt &&
mingchen0919
parents: 4
diff changeset
29
mingchen0919
parents: 4
diff changeset
30 Rscript '${__tool_directory__}/htseq_count_render.R'
mingchen0919
parents: 4
diff changeset
31
0
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
32 -o $report
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
33 -d $report.files_path
5
mingchen0919
parents: 4
diff changeset
34
2
db9da9716914 add r-dt
mingchen0919
parents: 1
diff changeset
35 -A '$alignment_files'
3
1545e24c9ba7 add r-dt
mingchen0919
parents: 2
diff changeset
36 -B '$sample_names'
2
db9da9716914 add r-dt
mingchen0919
parents: 1
diff changeset
37 -G $gff
1
mingchen0919
parents: 0
diff changeset
38 -f $format
mingchen0919
parents: 0
diff changeset
39 -r $order
mingchen0919
parents: 0
diff changeset
40 -S $stranded
mingchen0919
parents: 0
diff changeset
41 -a $minaqual
mingchen0919
parents: 0
diff changeset
42 -T $feature_type
mingchen0919
parents: 0
diff changeset
43 -i $idattr
2
db9da9716914 add r-dt
mingchen0919
parents: 1
diff changeset
44 -m $mode
4
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
45 -c $count
6
7c54fd452b8e add kableExtra package
mingchen0919
parents: 5
diff changeset
46 -O $count_rdata
5
mingchen0919
parents: 4
diff changeset
47
mingchen0919
parents: 4
diff changeset
48 ]]></command>
4
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
49 <inputs>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
50 <param type="data" name="alignment_files" label="Alignment file (SAM/BAM)" optional="False" format="sam,bam"
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
51 multiple="True"/>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
52 <param type="text" name="sample_names" label="Sample names"
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
53 help="sample names for each input SAM/BAM file. Use comma to separate multiple names, for example, sample_1, sample_2, sample_3. The number of sample names should be the same as the number of input SAM/BAM files."
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
54 optional="False" size="5x25"/>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
55 <param type="select" name="format" argument="-f" label="Input data format" optional="False" multiple="False">
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
56 <option value="sam" selected="false">SAM</option>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
57 <option value="bam" selected="true">BAM</option>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
58 </param>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
59 <param type="data" name="gff" label="GFF file" optional="False" format="gff, gff3"/>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
60 <param type="select" name="order" argument="-r" label="Order"
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
61 help="Use this option to indicate how the input data has been sorted. The default is name.&#13;&#10;&#13;&#10;"
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
62 optional="False" multiple="False">
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
63 <option value="name" selected="false">Name</option>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
64 <option value="pos" selected="false">Position</option>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
65 </param>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
66 <param type="select" name="stranded" argument="-s" label="Stranded" optional="False" multiple="False">
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
67 <option value="yes" selected="true">Yes</option>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
68 <option value="no" selected="false">No</option>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
69 <option value="reverse" selected="false">Reverse</option>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
70 </param>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
71 <param type="integer" name="minaqual" argument="-a" label="Alignment quality "
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
72 help="Skip all reads with alignment quality lower than the given minimum value (default: 10)"
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
73 optional="False" value="10" min="0"/>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
74 <param type="text" name="feature_type" argument="-t" label="Feature type"
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
75 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)"
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
76 optional="False" value="exon"/>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
77 <param type="text" name="idattr" argument="-i" label="ID attribute"
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
78 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."
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
79 optional="False" value="gene_id"/>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
80 <param type="select" name="mode" argument="-m" label="Mode"
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
81 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)"
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
82 optional="False" multiple="False">
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
83 <option value="union" selected="true">Union</option>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
84 <option value="intersection-strict" selected="false">Intersection (strict)</option>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
85 <option value="intersection-nonempty" selected="false">Intersection (nonempty)</option>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
86 </param>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
87 </inputs>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
88 <outputs>
5
mingchen0919
parents: 4
diff changeset
89 <data name="report" format="html" label="${tool.name} report on ${on_string}" hidden="false"/>
4
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
90 <data name="count" format="txt" label="Aurora htseq-count on ${on_string}" hidden="false"/>
5
mingchen0919
parents: 4
diff changeset
91 <data name="count_rdata" format="rdata" label="${tool.name} count data on ${on_string}"/>
4
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
92 </outputs>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
93 <citations>
0
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
94 <citation type="bibtex"><![CDATA[
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
95 @article{allaire2016rmarkdown,
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
96 title={rmarkdown: Dynamic Documents for R, 2016},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
97 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
98 and Wickham, Hadley and Atkins, Aron and Hyndman, Rob},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
99 journal={R package version 0.9},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
100 volume={6},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
101 year={2016}
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
102 }
4
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
103 ]]></citation>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
104 <citation type="bibtex"><![CDATA[
0
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
105 @book{xie2015dynamic,
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
106 title={Dynamic Documents with R and knitr},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
107 author={Xie, Yihui},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
108 volume={29},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
109 year={2015},
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
110 publisher={CRC Press}
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
111 }
4
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
112 ]]></citation>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
113 <citation type="bibtex"><![CDATA[@article{anders2015htseq,
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
114 title={HTSeq—a Python framework to work with high-throughput sequencing data},
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
115 author={Anders, Simon and Pyl, Paul Theodor and Huber, Wolfgang},
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
116 journal={Bioinformatics},
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
117 volume={31},
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
118 number={2},
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
119 pages={166--169},
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
120 year={2015},
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
121 publisher={Oxford University Press}
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
122 }]]></citation>
0fdb0d5f53ce add rdata output
mingchen0919
parents: 3
diff changeset
123 </citations>
0
10a460f61ac2 planemo upload
mingchen0919
parents:
diff changeset
124 </tool>