annotate rsem_calculate_expression.xml @ 1:1ff2fc8da328

Updates to rsem_calculate_expression.xml
author Jim Johnson <jj@umn.edu>
date Thu, 05 Dec 2013 10:54:28 -0600 (2013-12-05)
parents 64d45f959303
children f6b8155ab12a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
1 <tool id="rsem_calculate_expression" name="RSEM calculate expression" version="1.1.17">
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
2 <description>RNA-Seq by Expectation-Maximization</description>
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
3 <requirements>
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
4 <requirement type="package" version="1.1.17">rsem</requirement>
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
5 <requirement type="package" version="0.1.19">samtools</requirement>
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
6 <requirement type="package" version="1.0.0">bowtie</requirement>
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
7 </requirements>
1
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
8 <command>
0
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
9 rsem-calculate-expression
1
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
10 ## --tag string
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
11 #if $seedlength:
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
12 --seed-length $seedlength
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
13 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
14 --forward-prob $forward_prob
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
15 #if $rsem_options.fullparams == 'fullset':
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
16 ## Fragment info
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
17 #if $rsem_options.fragment_length_mean:
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
18 --fragment-length-mean $rsem_options.fragment_length_mean
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
19 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
20 #if $rsem_options.fragment_length_min:
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
21 --fragment-length-min $rsem_options.fragment_length_min
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
22 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
23 #if $rsem_options.fragment_length_sd:
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
24 --fragment-length-sd $rsem_options.fragment_length_sd
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
25 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
26 #if $rsem_options.fragment_length_max:
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
27 --fragment-length-max $rsem_options.fragment_length_max
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
28 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
29 ## RSPD
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
30 #if $rsem_options.rspd.estimate == 'yes':
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
31 --estimate-rspd
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
32 #if $rsem_options.rspd.num_rspd_bins:
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
33 --num-rspd-bins $rsem_options.rspd.num_rspd_bins
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
34 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
35 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
36 ## Calculate 95% credibility intervals and posterior mean estimates.
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
37 #if $rsem_options.useci.ci == 'yes':
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
38 --calc-ci
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
39 #if $rsem_options.useci.cimem:
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
40 --ci-memory $rsem_options.useci.cimem
0
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
41 #end if
1
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
42 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
43 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
44 ## --num-threads $GALAXY_SLOTS
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
45 #if $input.format != 'bam' and $input.bowtie_options.fullparams == 'fullset':
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
46 ## Bowtie params
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
47 #if $bowtie_options.bowtie_e:
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
48 --bowtie-e $bowtie_options.bowtie_e
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
49 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
50 #if $bowtie_options.bowtie_m:
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
51 --bowtie-m $bowtie_options.bowtie_m
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
52 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
53 #if $bowtie_options.bowtie_n:
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
54 --bowtie-n $bowtie_options.bowtie_n
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
55 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
56 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
57 ## Outputs
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
58 #if $rsem_outputs.result_bams == 'none':
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
59 --no-bam-output
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
60 #else
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
61 #if $rsem_outputs.result_bams == 'both':
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
62 --output-genome-bam
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
63 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
64 $rsem_outputs.sampling_for_bam
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
65 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
66 ## Input data
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
67 #if $input.format=="fastq"
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
68 $input.fastq_select
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
69 #if $input.fastq.matepair=="single":
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
70 $input.fastq.singlefastq
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
71 #elif $input.fastq.matepair=="paired":
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
72 --paired-end
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
73 $input.fastq.fastq1
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
74 $input.fastq.fastq2
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
75 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
76 #elif $input.format=="fasta"
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
77 --no-qualities
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
78 #if $input.fasta.matepair=="single":
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
79 $input.fasta.singlefasta
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
80 #elif $input.fasta.matepair=="paired":
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
81 --paired-end
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
82 $input.fasta.fasta1
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
83 $input.fasta.fasta2
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
84 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
85 #elif $input.format=="sam"
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
86 #if $input.matepair=="paired":
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
87 --paired-end
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
88 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
89 #if $input.rsem_sam._extension == 'sam':
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
90 --sam
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
91 #elif $input.rsem_sam._extension == 'bam':
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
92 --bam
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
93 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
94 $input.rsem_sam
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
95 #end if
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
96 ## RSEM reference
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
97 #if $reference.refSrc == 'history':
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
98 ${reference.rsem_ref.extra_files_path}/${reference.rsem_ref.metadata.reference_name}
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
99 #elif $reference.refSrc == 'cached':
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
100 ${reference.index.fields.path}
0
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
101 #end if
1
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
102 ## sample_name: use a hard coded name so we can pull out galaxy outputs
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
103 rsem_output
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
104 ## direct output into logfile
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
105 > $log
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
106 </command>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
107 <macros>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
108 <macro name="rsem_options">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
109 <param name="seedlength" type="integer" value="25" optional="true" label="Seed length used by the read aligner" help="Providing the correct value for this parameter is important for RSEM's accuracy if the data are single-end reads. RSEM uses this value for Bowtie's seed length parameter. The minimum value is 25. (Default:25)">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
110 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
111 <param name="forward_prob" type="select" label="Is the library strand specific?">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
112 <option value="0.5" selected="true">No</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
113 <option value="1">Yes, the reads (or first reads from paired-end libraries) are only in the forward orientation</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
114 <option value="0">Yes, the reads (or first reads from paired-end libraries) are only in the reverse orientation</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
115 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
116 <conditional name="rsem_options">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
117 <param name="fullparams" type="select" label="Additional RSEM options">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
118 <option value="default">Use RSEM Defaults</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
119 <option value="fullset">Set Additional RSEM Options</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
120 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
121 <when value="default"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
122 <when value="fullset">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
123 <param name="fragment_length_min" type="integer" value="1" optional="true" label="Minimum read/insert length." help=" This is also the value for the bowtie -I option">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
124 <validator type="in_range" message="0 or greater" min="0" />
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
125 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
126 <param name="fragment_length_max" type="integer" value="1000" optional="true" label="Maximum read/insert length." help=" This is also the value for the bowtie -X option">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
127 <validator type="in_range" message="0 or greater" min="0" max="1000000"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
128 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
129 <param name="fragment_length_mean" type="float" value="" optional="true" label="Fragment length mean (single-end data only)" help="The mean of the fragment length distribution, which is assumed to be a Gaussian. (Default: -1, which disables use of the fragment length distribution)">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
130 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
131 <param name="fragment_length_sd" type="float" value="" optional="true" label="The standard deviation of the fragment length distribution (single-end data only)" help="Default 0, which assumes that all fragments are of the same length, given by the rounded value of fragment length mean. ">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
132 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
133 <conditional name="rspd">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
134 <param name="estimate" type="select" lanel="Read Start Position Distribution (RSPD)"
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
135 help="Set this option if you want to estimate the read start position distribution (RSPD) from data. Otherwise, RSEM will use a uniform RSPD.">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
136 <option value="no" selected="true">Use a uniform RSPD</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
137 <option value="yes">Estimate and correct for a non-uniform RSPD</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
138 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
139 <when value="no"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
140 <when value="yes">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
141 <param name="num_rspd_bins" type="integer" value="20" optional="true" label="Number of bins in the RSPD." help="Use of the default setting of 20 is recommended.">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
142 <validator type="in_range" message="" min="0" max="100"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
143 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
144 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
145 </conditional>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
146 <conditional name="useci">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
147 <param name="ci" type="select" label="Calculate 95% Credibility Intervals">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
148 <option value="no" selected="true">no</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
149 <option value="yes">yes</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
150 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
151 <when value="no"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
152 <when value="yes">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
153 <param name="cimem" size="4" type="text" value="1024" label="Amount of memory in (MB) for computing CI" />
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
154 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
155 </conditional>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
156 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
157 </conditional>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
158 </macro>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
159 <macro name="bowtie_options">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
160 <conditional name="bowtie_options">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
161 <param name="fullparams" type="select" label="bowtie settings">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
162 <option value="default">use bowtie defaults</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
163 <option value="fullset">set bowtie options</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
164 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
165 <when value="default"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
166 <when value="fullset">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
167 <param name="bowtie_n" type="integer" value="2" optional="true" label="Bowtie mismatches" help="Bowtie parameter max # of mismatches in the seed. (Range: 0-3, Default: 2) ">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
168 <validator type="in_range" message="max # of mismatches in the seed between 0 and 3" min="0" max="3"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
169 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
170 <param name="bowtie_e" type="integer" value="99999999" label="Maximum sum of quality scores at mismatched positions in read alignments. This is also the value for the Bowtie -e option">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
171 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
172 <param name="bowtie_m" type="integer" value="200" label="Discard alignments for reads with number of alignments greater than">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
173 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
174 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
175 </conditional>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
176 </macro>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
177 <macro name="sampling_for_bam">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
178 <param name="sampling_for_bam" type="boolean" truevalue="--sampling-for-bam" falsevalue="" checked="false" label="Use sampling for BAM">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
179 <help> When RSEM generates a BAM file, instead of outputing all alignments a read has with their posterior probabilities, one alignment is sampled according to the posterior probabilities. The sampling procedure includes the alignment to the "noise" transcript, which does not appear in the BAM file. Only the sampled alignment has a weight of 1. All other alignments have weight 0. If the "noise" transcript is sampled, all alignments appeared in the BAM file should have weight 0. (Default: off)
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
180 </help>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
181 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
182 </macro>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
183 </macros>
0
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
184
1
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
185 <inputs>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
186 <param name="sample" type="text" value="rsem_sample" label="Sample name" />
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
187 <conditional name="reference">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
188 <param name="refSrc" type="select" label="RSEM Reference">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
189 <option value="cached">Locally cached</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
190 <option value="history">From your history</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
191 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
192 <when value="cached">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
193 <param name="index" type="select" label="Select RSEM reference" help="Select from a list of pre-indexed references. If you don't see anything consult the wrapper's documentation on how to create or download a reference">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
194 <options from_data_table="rsem_indexes">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
195 <filter type="sort_by" column="2" />
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
196 <validator type="no_options" message="No indexes are available" />
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
197 </options>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
198 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
199 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
200 <when value="history">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
201 <param name="rsem_ref" type="data" format="rsem_ref" label="RSEM reference" />
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
202 </when>
0
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
203 </conditional>
1
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
204 <conditional name="input">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
205 <param name="format" type="select" label="RSEM Input file type">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
206 <option value="fastq">FASTQ</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
207 <option value="fasta">FASTA</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
208 <option value="sam">SAM/BAM</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
209 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
210 <when value="fastq">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
211 <param name="fastq_select" size="15" type="select" label="FASTQ type" >
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
212 <option value="--phred33-quals">phred33 qualities (default for sanger)</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
213 <option value="--solexa-quals">solexa qualities</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
214 <option value="--phred64-quals">phred64 qualities</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
215 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
216 <conditional name="fastq">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
217 <param name="matepair" type="select" label="Library type">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
218 <option value="single">Single End Reads</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
219 <option value="paired">Paired End Reads</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
220 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
221 <when value="single">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
222 <param name="singlefastq" type="data" format="fastq" label="FASTQ file" />
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
223 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
224 <when value="paired">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
225 <param name="fastq1" type="data" format="fastq" label="Read 1 fastq file" />
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
226 <param name="fastq2" type="data" format="fastq" label="Read 2 fastq file" />
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
227 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
228 </conditional>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
229 <expand macro="bowtie_options"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
230 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
231 <when value="fasta">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
232 <conditional name="fasta">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
233 <param name="matepair" type="select" label="Library Type">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
234 <option value="single">Single End Reads</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
235 <option value="paired">Paired End Reads</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
236 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
237 <when value="single">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
238 <param name="singlefasta" type="data" format="fasta" label="fasta file" />
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
239 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
240 <when value="paired">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
241 <param name="fasta1" type="data" format="fasta" label="Read 1 fasta file" />
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
242 <param name="fasta2" type="data" format="fasta" label="Read 2 fasta file" />
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
243 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
244 </conditional>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
245 <expand macro="bowtie_options"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
246 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
247 <when value="sam">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
248 <!-- convert-sam-for-rsem /ref/mouse_125 input.sam -o input_for_rsem.sam -->
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
249 <param name="matepair" type="select" label="Library Type">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
250 <option value="single">Single End Reads</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
251 <option value="paired">Paired End Reads</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
252 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
253 <param name="rsem_sam" type="data" format="rsem_sam" label="RSEM formatted SAM file" />
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
254 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
255 </conditional>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
256 <expand macro="rsem_options"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
257 <conditional name="rsem_outputs">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
258 <param name="result_bams" type="select" label="Create bam results files"
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
259 help="In addition to the transcript-coordinate-based BAM file output, also output a BAM file with the read alignments in genomic coordinates" >
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
260 <option value="none">No BAM results files</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
261 <option value="default" selected="true">Transcript BAM results file</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
262 <option value="both">Transcript and genome BAM results files</option>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
263 </param>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
264 <when value="none"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
265 <when value="default">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
266 <expand macro="sampling_for_bam"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
267 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
268 <when value="both">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
269 <expand macro="sampling_for_bam"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
270 </when>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
271 </conditional>
0
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
272 </inputs>
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
273 <stdio>
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
274 <exit_code range="1:" level="fatal" description="Error Running RSEM" />
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
275 </stdio>
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
276 <outputs>
1
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
277 <data format="tabular" name="output" label="${sample}.gene_abundances" from_work_dir="rsem_output.genes.results"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
278 <data format="tabular" name="isoforms" label="${sample}.isoform_abundances" from_work_dir="rsem_output.isoforms.results"/>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
279 <data format="bam" name="transcript_bam" label="${sample}.transcript.bam" from_work_dir="rsem_output.transcript.bam" >
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
280 <filter>rsem_outputs['result_bams'] != "none"</filter>
0
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
281 </data>
1
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
282 <data format="bam" name="transcript__sorted_bam" label="${sample}.transcript.bam" from_work_dir="rsem_output.transcript.sorted.bam" >
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
283 <filter>rsem_outputs['result_bams'] != "none"</filter>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
284 </data>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
285 <data format="bam" name="genome_bam" label="${sample}.genome.bam" from_work_dir="rsem_output.genome.bam">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
286 <filter>rsem_outputs['result_bams'] == "both"</filter>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
287 </data>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
288 <data format="bam" name="genome_sorted_bam" label="${sample}.genome.bam" from_work_dir="rsem_output.genome.sorted.bam">
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
289 <filter>rsem_outputs['result_bams'] == "both"</filter>
1ff2fc8da328 Updates to rsem_calculate_expression.xml
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
290 </data>
0
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
291 <data format="txt" name="log" label="${sample}.rsem_log"/>
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
292 </outputs>
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
293 <help>
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
294
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
295
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
296 RSEM HOME PAGE - http://deweylab.biostat.wisc.edu/rsem/
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
297
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
298 NAME
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
299 rsem-calculate-expression
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
300
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
301 SYNOPSIS
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
302 rsem-calculate-expression [options] upstream_read_file(s) reference_name sample_name
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
303 rsem-calculate-expression [options] --paired-end upstream_read_file/s downstream_read_file/s reference_name sample_name
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
304 rsem-calculate-expression [options] --sam/--bam [--paired-end] input reference_name sample_name
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
305
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
306 ARGUMENTS
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
307 upstream_read_files/s
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
308 Comma-separated list of files containing single-end reads or
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
309 upstream reads for paired-end data. By default, these files are
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
310 assumed to be in FASTQ format. If the --no-qualities option is
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
311 specified, then FASTA format is expected.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
312
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
313 downstream_read_file/s
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
314 Comma-separated list of files containing downstream reads which are
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
315 paired with the upstream reads. By default, these files are assumed
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
316 to be in FASTQ format. If the --no-qualities option is specified,
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
317 then FASTA format is expected.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
318
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
319 input
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
320 SAM/BAM formatted input file. If "-" is specified for the filename,
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
321 SAM/BAM input is instead assumed to come from standard input. RSEM
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
322 requires all alignments of the same read group together. For
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
323 paired-end reads, RSEM also requires the two mates of any alignment
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
324 be adjacent. See Description section for how to make input file obey
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
325 RSEM's requirements.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
326
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
327 reference_name
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
328 The name of the reference used. The user must have run
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
329 'rsem-prepare-reference' with this reference_name before running
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
330 this program.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
331
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
332 sample_name
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
333 The name of the sample analyzed. All output files are prefixed by
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
334 this name (e.g., sample_name.genes.results)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
335
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
336 OPTIONS
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
337
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
338 --paired-end
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
339 Input reads are paired-end reads. (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
340
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
341 --no-qualities
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
342 Input reads do not contain quality scores. (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
343
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
344 --strand-specific
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
345 The RNA-Seq protocol used to generate the reads is strand specific,
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
346 i.e., all (upstream) reads are derived from the forward strand. This
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
347 option is equivalent to --forward-prob=1.0. With this option set, if
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
348 RSEM runs the Bowtie aligner, the '--norc' Bowtie option will be
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
349 used, which disables alignment to the reverse strand of transcripts.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
350 (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
351
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
352 --sam
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
353 Input file is in SAM format. (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
354
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
355 --bam
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
356 Input file is in BAM format. (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
357
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
358 --sam-header-info [file]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
359 RSEM reads header information from input by default. If this option
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
360 is on, header information is read from the specified file. For the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
361 format of the file, please see SAM official website. (Default: "")
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
362
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
363 -p/--num-threads [int]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
364 Number of threads to use. Both Bowtie and expression estimation will
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
365 use this many threads. (Default: 1)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
366
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
367 --no-bam-output
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
368 Do not output any BAM file. (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
369
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
370 --output-genome-bam
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
371 Generate a BAM file, 'sample_name.genome.bam', with alignments
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
372 mapped to genomic coordinates and annotated with their posterior
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
373 probabilities. In addition, RSEM will call samtools (included in
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
374 RSEM package) to sort and index the bam file.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
375 'sample_name.genome.sorted.bam' and
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
376 'sample_name.genome.sorted.bam.bai' will be generated. (Default:
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
377 off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
378
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
379 --sampling-for-bam
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
380 When RSEM generates a BAM file, instead of outputing all alignments
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
381 a read has with their posterior probabilities, one alignment is
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
382 sampled and outputed according to the posterior probabilities. If
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
383 the sampling result is that the read comes from the "noise"
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
384 transcript, nothing is outputed. (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
385
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
386 --calc-ci
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
387 Calculate 95% credibility intervals and posterior mean estimates.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
388 (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
389
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
390 --seed-length [int]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
391 Seed length used by the read aligner. Providing the correct value is
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
392 important for RSEM. If RSEM runs Bowtie, it uses this value for
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
393 Bowtie's seed length parameter. Any read with its or at least one of
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
394 its mates' (for paired-end reads) length less than this value will
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
395 be ignored. If the references are not added poly(A) tails, the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
396 minimum allowed value is 5, otherwise, the minimum allowed value is
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
397 25. Note that this script will only check if the value less or equal than
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
398 5 and give a warning message if the value less than 25 but greter or equal than
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
399 5. (Default: 25)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
400
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
401 --tag [string]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
402 The name of the optional field used in the SAM input for identifying
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
403 a read with too many valid alignments. The field should have the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
404 format [tagName]:i:[value], where a [value] bigger than 0 indicates
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
405 a read with too many alignments. (Default: "")
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
406
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
407 --bowtie-path [path]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
408 The path to the bowtie executables. (Default: the path to the bowtie
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
409 executables is assumed to be in the user's PATH environment
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
410 variable)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
411
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
412 --bowtie-n [int]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
413 (Bowtie parameter) max # of mismatches in the seed. (Range: 0-3,
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
414 Default: 2)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
415
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
416 --bowtie-e [int]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
417 (Bowtie parameter) max sum of mismatch quality scores across the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
418 alignment. (Default: 99999999)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
419
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
420 --bowtie-m [int]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
421 (Bowtie parameter) suppress all alignments for a read if greater then [int]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
422 valid alignments exist. (Default: 200)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
423
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
424 --bowtie-chunkmbs [int]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
425 (Bowtie parameter) memory allocated for best first alignment
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
426 calculation (Default: 0 - use bowtie's default)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
427
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
428 --phred33-quals
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
429 Input quality scores are encoded as Phred+33. (Default: on)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
430
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
431 --phred64-quals
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
432 Input quality scores are encoded as Phred+64 (default for GA
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
433 Pipeline ver. less than 1.3). (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
434
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
435 --solexa-quals
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
436 Input quality scores are solexa encoded (from GA Pipeline ver. less
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
437 than 1.3). (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
438
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
439 --forward-prob [double]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
440 Probability of generating a read from the forward strand of a
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
441 transcript. Set to 1 for a strand-specific protocol where all
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
442 (upstream) reads are derived from the forward strand, 0 for a
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
443 strand-specific protocol where all (upstream) read are derived from
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
444 the reverse strand, or 0.5 for a non-strand-specific protocol.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
445 (Default: 0.5)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
446
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
447 --fragment-length-min [int]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
448 Minimum read/insert length allowed. This is also the value for the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
449 bowtie -I option. (Default: 1)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
450
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
451 --fragment-length-max [int]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
452 Maximum read/insert length allowed. This is also the value for the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
453 bowtie -X option. (Default: 1000)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
454
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
455 --fragment-length-mean [double]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
456 (single-end data only) The mean of the fragment length distribution,
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
457 which is assumed to be a Gaussian. (Default: -1, which disables use
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
458 of the fragment length distribution)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
459
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
460 --fragment-length-sd [double]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
461 (single-end data only) The standard deviation of the fragment length
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
462 distribution, which is assumed to be a Gaussian. (Default: 0, which
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
463 assumes that all fragments are of the same length, given by the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
464 rounded value of --fragment-length-mean)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
465
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
466 --estimate-rspd
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
467 Set this option if you want to estimate the read start position
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
468 distribution (RSPD) from data. Otherwise, RSEM will use a uniform
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
469 RSPD. (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
470
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
471 --num-rspd-bins [int]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
472 Number of bins in the RSPD. Only relevant when '--estimate-rspd' is
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
473 specified. Use of the default setting is recommended. (Default: 20)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
474
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
475 --ci-memory [int]
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
476 Maximum size (in memory, MB) of the auxiliary buffer used for
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
477 computing credibility intervals (CI). Set it larger for a faster CI
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
478 calculation. However, leaving 2 GB memory free for other usage is
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
479 recommended. (Default: 1024)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
480
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
481 --keep-intermediate-files
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
482 Keep temporary files generated by RSEM. RSEM creates a temporary
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
483 directory, 'sample_name.temp', into which it puts all intermediate
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
484 output files. If this directory already exists, RSEM overwrites all
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
485 files generated by previous RSEM runs inside of it. By default,
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
486 after RSEM finishes, the temporary directory is deleted. Set this
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
487 option to prevent the deletion of this directory and the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
488 intermediate files inside of it. (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
489
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
490 --time
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
491 Output time consumed by each step of RSEM to 'sample_name.time'.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
492 (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
493
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
494 -q/--quiet
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
495 Suppress the output of logging information. (Default: off)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
496
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
497 -h/--help
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
498 Show help information.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
499
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
500 DESCRIPTION
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
501 In its default mode, this program aligns input reads against a reference
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
502 transcriptome with Bowtie and calculates expression values using the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
503 alignments. RSEM assumes the data are single-end reads with quality
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
504 scores, unless the '--paired-end' or '--no-qualities' options are
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
505 specified. Users may use an alternative aligner by specifying one of the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
506 --sam and --bam options, and providing an alignment file in the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
507 specified format. However, users should make sure that they align
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
508 against the indices generated by 'rsem-prepare-reference' and the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
509 alignment file satisfies the requirements mentioned in ARGUMENTS
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
510 section.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
511
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
512 One simple way to make the alignment file satisfying RSEM's requirements
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
513 (assuming the aligner used put mates in a paired-end read adjacent) is
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
514 to use 'convert-sam-for-rsem' script. This script only accept SAM format
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
515 files as input. If a BAM format file is obtained, please use samtools to
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
516 convert it to a SAM file first. For example, if '/ref/mouse_125' is the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
517 'reference_name' and the SAM file is named 'input.sam', you can run the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
518 following command:
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
519
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
520 convert-sam-for-rsem /ref/mouse_125 input.sam -o input_for_rsem.sam
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
521
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
522 For details, please refer to 'convert-sam-for-rsem's documentation page.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
523
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
524 The SAM/BAM format RSEM uses is v1.4. However, it is compatible with old
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
525 SAM/BAM format. However, RSEM cannot recognize 0x100 in the FLAG field.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
526 In addition, RSEM requires SEQ and QUAL are not '*'.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
527
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
528 The user must run 'rsem-prepare-reference' with the appropriate
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
529 reference before using this program.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
530
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
531 For single-end data, it is strongly recommended that the user provide
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
532 the fragment length distribution parameters (--fragment-length-mean and
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
533 --fragment-length-sd). For paired-end data, RSEM will automatically
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
534 learn a fragment length distribution from the data.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
535
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
536 Please note that some of the default values for the Bowtie parameters
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
537 are not the same as those defined for Bowtie itself.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
538
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
539 The temporary directory and all intermediate files will be removed when
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
540 RSEM finishes unless '--keep-intermediate-files' is specified.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
541
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
542 With the '--calc-ci' option, 95% credibility intervals and posterior
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
543 mean estimates will be calculated in addition to maximum likelihood
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
544 estimates.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
545
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
546 OUTPUT
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
547 sample_name.genes.results
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
548 File containing gene level expression estimates. The format of each
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
549 line in this file is:
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
550
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
551 gene_id expected_counts tau_value [pmc_value tau_pme_value
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
552 tau_ci_lower_bound tau_ci_upper_bound] transcript_id_list
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
553
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
554 Fields are separated by the tab character. Fields within "[]" are
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
555 only presented if '--calc-ci' is set. pme stands for posterior mean
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
556 estimation. pmc stands for posterior mean counts. ci_lower_bound(l)
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
557 means the lower bound of the credibility intervals,
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
558 ci_upper_bound(u) means the upper bound of the credibility
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
559 intervals. So the credibility interval is [l, u].
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
560 'transcript_id_list' is a space-separated list of transcript_ids
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
561 belonging to the gene. If no gene information is provided, this file
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
562 has the same content as 'sample_name.isoforms.results'.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
563
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
564 sample_name.isoforms.results
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
565 File containing isoform level expression values. The format of each
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
566 line in this file is:
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
567
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
568 transcript_id expected_counts tau_value [pmc_value tau_pme_value
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
569 tau_ci_lower_bound tau_ci_upper_bound] gene_id
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
570
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
571 Fields are separated by the tab character. 'gene_id' is the gene_id
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
572 of the gene which this transcript belongs to. If no gene information
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
573 is provided, 'gene_id' and 'transcript_id' are the same.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
574
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
575 sample_name.transcript.bam, sample_name.transcript.sorted.bam and
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
576 sample_name.transcript.sorted.bam.bai
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
577 Only generated when --no-bam-output is not specified.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
578
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
579 'sample_name.transcript.bam' is a BAM-formatted file of read
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
580 alignments in transcript coordinates. The MAPQ field of each
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
581 alignment is set to min(100, floor(-10 * log10(1.0 - w) + 0.5)),
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
582 where w is the posterior probability of that alignment being the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
583 true mapping of a read. In addition, RSEM pads a new tag ZW:f:value,
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
584 where value is a single precision floating number representing the
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
585 posterior probability.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
586
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
587 'sample_name.transcript.sorted.bam' and
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
588 'sample_name.transcript.sorted.bam.bai' are the sorted BAM file and
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
589 indices generated by samtools (included in RSEM package).
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
590
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
591 sample_name.genome.bam, sample_name.genome.sorted.bam and
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
592 sample_name.genome.sorted.bam.bai
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
593 Only generated when --no-bam-output is not specified and
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
594 --output-genome-bam is specified.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
595
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
596 'sample_name.genome.bam' is a BAM-formatted file of read alignments
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
597 in genomic coordinates. Alignments of reads that have identical
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
598 genomic coordinates (i.e., alignments to different isoforms that
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
599 share the same genomic region) are collapsed into one alignment. The
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
600 MAPQ field of each alignment is set to min(100, floor(-10 *
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
601 log10(1.0 - w) + 0.5)), where w is the posterior probability of that
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
602 alignment being the true mapping of a read. In addition, RSEM pads a
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
603 new tag ZW:f:value, where value is a single precision floating
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
604 number representing the posterior probability. If an alignment is
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
605 spliced, a XS:A:value tag is also added, where value is either '+'
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
606 or '-' indicating the strand of the transcript it aligns to.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
607
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
608 'sample_name.genome.sorted.bam' and
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
609 'sample_name.genome.sorted.bam.bai' are the sorted BAM file and
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
610 indices generated by samtools (included in RSEM package).
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
611
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
612 sample_name.sam.gz
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
613 Only generated when the input files are raw reads instead of SAM/BAM
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
614 format files
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
615
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
616 It is the gzipped SAM output produced by bowtie aligner.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
617
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
618 sample_name.time
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
619 Only generated when --time is specified.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
620
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
621 It contains time (in seconds) consumed by aligning reads, estimating
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
622 expression levels and calculating credibility intervals.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
623
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
624 sample_name.stat
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
625 This is a folder instead of a file. All model related statistics are
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
626 stored in this folder. Use 'rsem-plot-model' can generate plots
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
627 using this folder.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
628
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
629 EXAMPLES
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
630 Assume the path to the bowtie executables is in the user's PATH
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
631 environment variable. Reference files are under '/ref' with name
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
632 'mouse_125'.
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
633
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
634 1) '/data/mmliver.fq', single-end reads with quality scores. Quality
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
635 scores are encoded as for 'GA pipeline version >= 1.3'. We want to use 8
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
636 threads and generate a genome BAM file:
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
637
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
638 rsem-calculate-expression --phred64-quals \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
639 -p 8 \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
640 --output-genome-bam \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
641 /data/mmliver.fq \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
642 /ref/mouse_125 \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
643 mmliver_single_quals
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
644
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
645 2) '/data/mmliver_1.fq' and '/data/mmliver_2.fq', paired-end reads with
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
646 quality scores. Quality scores are in SANGER format. We want to use 8
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
647 threads and do not generate a genome BAM file:
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
648
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
649 rsem-calculate-expression -p 8 \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
650 --paired-end \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
651 /data/mmliver_1.fq \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
652 /data/mmliver_2.fq \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
653 /ref/mouse_125 \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
654 mmliver_paired_end_quals
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
655
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
656 3) '/data/mmliver.fa', single-end reads without quality scores. We want
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
657 to use 8 threads:
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
658
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
659 rsem-calculate-expression -p 8 \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
660 --no-qualities \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
661 /data/mmliver.fa \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
662 /ref/mouse_125 \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
663 mmliver_single_without_quals
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
664
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
665 4) Data are the same as 1). We want to take a fragment length
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
666 distribution into consideration. We set the fragment length mean to 150
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
667 and the standard deviation to 35. In addition to a BAM file, we also
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
668 want to generate credibility intervals. We allow RSEM to use 1GB of
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
669 memory for CI calculation:
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
670
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
671 rsem-calculate-expression --bowtie-path /sw/bowtie \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
672 --phred64-quals \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
673 --fragment-length-mean 150.0 \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
674 --fragment-length-sd 35.0 \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
675 -p 8 \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
676 --output-genome-bam \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
677 --calc-ci \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
678 --ci-memory 1024 \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
679 /data/mmliver.fq \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
680 /ref/mouse_125 \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
681 mmliver_single_quals
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
682
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
683 5) '/data/mmliver_paired_end_quals.bam', paired-end reads with quality
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
684 scores. We want to use 8 threads:
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
685
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
686 rsem-calculate-expression --paired-end \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
687 --bam \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
688 -p 8 \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
689 /data/mmliver_paired_end_quals.bam \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
690 /ref/mouse_125 \
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
691 mmliver_paired_end_quals
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
692 </help>
64d45f959303 Uploaded
jjohnson
parents:
diff changeset
693 </tool>