Mercurial > repos > devteam > cuffcompare
annotate cuffcompare_wrapper.xml @ 2:8b22e9adae34
Update to the new data table specification.
| author | Dave Bouvier <dave@bx.psu.edu> |
|---|---|
| date | Wed, 04 Dec 2013 13:24:29 -0500 |
| parents | 9d35cf35634e |
| children | 8e534225baa9 |
| rev | line source |
|---|---|
|
2
8b22e9adae34
Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents:
0
diff
changeset
|
1 <tool id="cuffcompare" name="Cuffcompare" version="0.0.6"> |
| 0 | 2 <!-- Wrapper supports Cuffcompare versions v1.3.0 and newer --> |
| 3 <description>compare assembled transcripts to a reference annotation and track Cufflinks transcripts across multiple experiments</description> | |
| 4 <requirements> | |
| 5 <requirement type="package" version="2.1.1">cufflinks</requirement> | |
| 6 </requirements> | |
| 7 <version_command>cuffcompare 2>&1 | head -n 1</version_command> | |
| 8 <command interpreter="python"> | |
| 9 cuffcompare_wrapper.py | |
| 10 | |
| 11 ## Use annotation reference? | |
| 12 #if $annotation.use_ref_annotation == "Yes": | |
| 13 -r $annotation.reference_annotation | |
| 14 #if $annotation.ignore_nonoverlapping_reference: | |
| 15 -R | |
| 16 #end if | |
| 17 #end if | |
| 18 | |
| 19 ## Use sequence data? | |
| 20 #if $seq_data.use_seq_data == "Yes": | |
|
2
8b22e9adae34
Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents:
0
diff
changeset
|
21 -s |
| 0 | 22 #if $seq_data.seq_source.index_source == "history": |
| 23 --ref_file=$seq_data.seq_source.ref_file | |
| 24 #else: | |
|
2
8b22e9adae34
Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents:
0
diff
changeset
|
25 --index=${seq_data.seq_source.index.fields.path} |
| 0 | 26 #end if |
| 27 #end if | |
| 28 | |
| 29 ## Outputs. | |
| 30 --combined-transcripts=${transcripts_combined} | |
| 31 | |
| 32 ## Inputs. | |
| 33 ${first_input} | |
| 34 #for $input_file in $input_files: | |
| 35 ${input_file.additional_input} | |
| 36 #end for | |
| 37 | |
| 38 </command> | |
| 39 <inputs> | |
| 40 <param format="gtf" name="first_input" type="data" label="GTF file produced by Cufflinks" help=""/> | |
| 41 <repeat name="input_files" title="Additional GTF Input Files"> | |
| 42 <param format="gtf" name="additional_input" type="data" label="GTF file produced by Cufflinks" help=""/> | |
| 43 </repeat> | |
| 44 <conditional name="annotation"> | |
| 45 <param name="use_ref_annotation" type="select" label="Use Reference Annotation"> | |
| 46 <option value="No">No</option> | |
| 47 <option value="Yes">Yes</option> | |
| 48 </param> | |
| 49 <when value="Yes"> | |
| 50 <param format="gff3,gtf" name="reference_annotation" type="data" label="Reference Annotation" help="Requires an annotation file in GFF3 or GTF format."/> | |
| 51 <param name="ignore_nonoverlapping_reference" type="boolean" label="Ignore reference transcripts that are not overlapped by any transcript in input files"/> | |
| 52 </when> | |
| 53 <when value="No"> | |
| 54 </when> | |
| 55 </conditional> | |
| 56 <conditional name="seq_data"> | |
| 57 <param name="use_seq_data" type="select" label="Use Sequence Data" help="Use sequence data for some optional classification functions, including the addition of the p_id attribute required by Cuffdiff."> | |
| 58 <option value="Yes">Yes</option> | |
| 59 <option value="No">No</option> | |
| 60 </param> | |
| 61 <when value="No"></when> | |
| 62 <when value="Yes"> | |
| 63 <conditional name="seq_source"> | |
| 64 <param name="index_source" type="select" label="Choose the source for the reference list"> | |
| 65 <option value="cached">Locally cached</option> | |
| 66 <option value="history">History</option> | |
| 67 </param> | |
|
2
8b22e9adae34
Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents:
0
diff
changeset
|
68 <when value="cached"> |
|
8b22e9adae34
Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents:
0
diff
changeset
|
69 <param name="index" type="select" label="Using reference genome"> |
|
8b22e9adae34
Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents:
0
diff
changeset
|
70 <options from_data_table="fasta_indexes"> |
|
8b22e9adae34
Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents:
0
diff
changeset
|
71 <filter type="data_meta" ref="first_input" key="dbkey" column="1" /> |
|
8b22e9adae34
Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents:
0
diff
changeset
|
72 <validator type="no_options" message="No reference genome is available for the build associated with the selected input dataset" /> |
|
8b22e9adae34
Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents:
0
diff
changeset
|
73 </options> |
|
8b22e9adae34
Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents:
0
diff
changeset
|
74 </param> |
|
8b22e9adae34
Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents:
0
diff
changeset
|
75 </when> |
| 0 | 76 <when value="history"> |
| 77 <param name="ref_file" type="data" format="fasta" label="Using reference file" /> | |
| 78 </when> | |
| 79 </conditional> | |
| 80 </when> | |
| 81 </conditional> | |
| 82 </inputs> | |
| 83 | |
| 84 <outputs> | |
| 85 <data format="txt" name="transcripts_accuracy" label="${tool.name} on ${on_string}: transcript accuracy" | |
| 86 from_work_dir="cc_output.stats" /> | |
| 87 <data format="tabular" name="input1_tmap" label="${tool.name} on ${on_string}: data ${first_input.hid} tmap file" | |
| 88 from_work_dir="cc_output.input1.tmap" /> | |
| 89 <data format="tabular" name="input1_refmap" | |
| 90 label="${tool.name} on ${on_string}: data ${first_input.hid} refmap file" | |
| 91 from_work_dir="cc_output.input1.refmap"> | |
| 92 <filter>annotation['use_ref_annotation'] == 'Yes'</filter> | |
| 93 </data> | |
| 94 <data format="tabular" name="input2_tmap" label="${tool.name} on ${on_string}: data ${input_files[0]['additional_input'].hid} tmap file" from_work_dir="cc_output.input2.tmap"> | |
| 95 <filter>len( input_files ) >= 1</filter> | |
| 96 </data> | |
| 97 <data format="tabular" name="input2_refmap" | |
| 98 label="${tool.name} on ${on_string}: data ${input_files[0]['additional_input'].hid} refmap file" | |
| 99 from_work_dir="cc_output.input2.refmap"> | |
| 100 <filter>annotation['use_ref_annotation'] == 'Yes' and len( input_files ) >= 1</filter> | |
| 101 </data> | |
| 102 <data format="tabular" name="transcripts_tracking" label="${tool.name} on ${on_string}: transcript tracking" from_work_dir="cc_output.tracking"> | |
| 103 <filter>len( input_files ) > 0</filter> | |
| 104 </data> | |
| 105 <data format="gtf" name="transcripts_combined" label="${tool.name} on ${on_string}: combined transcripts"/> | |
| 106 </outputs> | |
| 107 | |
| 108 <tests> | |
| 109 <!-- | |
| 110 cuffcompare -r cuffcompare_in3.gtf -R cuffcompare_in1.gtf cuffcompare_in2.gtf | |
| 111 --> | |
| 112 <test> | |
| 113 <param name="first_input" value="cuffcompare_in1.gtf" ftype="gtf"/> | |
| 114 <param name="additional_input" value="cuffcompare_in2.gtf" ftype="gtf"/> | |
| 115 <param name="use_ref_annotation" value="Yes"/> | |
| 116 <param name="reference_annotation" value="cuffcompare_in3.gtf" ftype="gtf"/> | |
| 117 <param name="ignore_nonoverlapping_reference" value="Yes"/> | |
| 118 <param name="use_seq_data" value="No"/> | |
| 119 <!-- Line diffs are the result of different locations for input files; this cannot be fixed as cuffcompare outputs | |
| 120 full input path for each input. --> | |
| 121 <output name="transcripts_accuracy" file="cuffcompare_out7.txt" lines_diff="16"/> | |
| 122 <output name="input1_tmap" file="cuffcompare_out1.tmap"/> | |
| 123 <output name="input1_refmap" file="cuffcompare_out2.refmap"/> | |
| 124 <output name="input2_tmap" file="cuffcompare_out3.tmap"/> | |
| 125 <output name="input2_refmap" file="cuffcompare_out4.refmap"/> | |
| 126 <output name="transcripts_tracking" file="cuffcompare_out6.tracking"/> | |
| 127 <output name="transcripts_combined" file="cuffcompare_out5.gtf"/> | |
| 128 </test> | |
| 129 </tests> | |
| 130 | |
| 131 <help> | |
| 132 **Cuffcompare Overview** | |
| 133 | |
| 134 Cuffcompare is part of Cufflinks_. Cuffcompare helps you: (a) compare your assembled transcripts to a reference annotation and (b) track Cufflinks transcripts across multiple experiments (e.g. across a time course). Please cite: Trapnell C, Williams BA, Pertea G, Mortazavi AM, Kwan G, van Baren MJ, Salzberg SL, Wold B, Pachter L. Transcript assembly and abundance estimation from RNA-Seq reveals thousands of new transcripts and switching among isoforms. Nature Biotechnology doi:10.1038/nbt.1621 | |
| 135 | |
| 136 .. _Cufflinks: http://cufflinks.cbcb.umd.edu/ | |
| 137 | |
| 138 ------ | |
| 139 | |
| 140 **Know what you are doing** | |
| 141 | |
| 142 .. class:: warningmark | |
| 143 | |
| 144 There is no such thing (yet) as an automated gearshift in expression analysis. It is all like stick-shift driving in San Francisco. In other words, running this tool with default parameters will probably not give you meaningful results. A way to deal with this is to **understand** the parameters by carefully reading the `documentation`__ and experimenting. Fortunately, Galaxy makes experimenting easy. | |
| 145 | |
| 146 .. __: http://cufflinks.cbcb.umd.edu/manual.html#cuffcompare | |
| 147 | |
| 148 ------ | |
| 149 | |
| 150 **Input format** | |
| 151 | |
| 152 Cuffcompare takes Cufflinks' GTF output as input, and optionally can take a "reference" annotation (such as from Ensembl_) | |
| 153 | |
| 154 .. _Ensembl: http://www.ensembl.org | |
| 155 | |
| 156 ------ | |
| 157 | |
| 158 **Outputs** | |
| 159 | |
| 160 Cuffcompare produces the following output files: | |
| 161 | |
| 162 Transcripts Accuracy File: | |
| 163 | |
| 164 Cuffcompare reports various statistics related to the "accuracy" of the transcripts in each sample when compared to the reference annotation data. The typical gene finding measures of "sensitivity" and "specificity" (as defined in Burset, M., Guigó, R. : Evaluation of gene structure prediction programs (1996) Genomics, 34 (3), pp. 353-367. doi: 10.1006/geno.1996.0298) are calculated at various levels (nucleotide, exon, intron, transcript, gene) for each input file and reported in this file. The Sn and Sp columns show specificity and sensitivity values at each level, while the fSn and fSp columns are "fuzzy" variants of these same accuracy calculations, allowing for a very small variation in exon boundaries to still be counted as a "match". | |
| 165 | |
| 166 Transcripts Combined File: | |
| 167 | |
| 168 Cuffcompare reports a GTF file containing the "union" of all transfrags in each sample. If a transfrag is present in both samples, it is thus reported once in the combined gtf. | |
| 169 | |
| 170 Transcripts Tracking File: | |
| 171 | |
| 172 This file matches transcripts up between samples. Each row contains a transcript structure that is present in one or more input GTF files. Because the transcripts will generally have different IDs (unless you assembled your RNA-Seq reads against a reference transcriptome), cuffcompare examines the structure of each the transcripts, matching transcripts that agree on the coordinates and order of all of their introns, as well as strand. Matching transcripts are allowed to differ on the length of the first and last exons, since these lengths will naturally vary from sample to sample due to the random nature of sequencing. | |
| 173 If you ran cuffcompare with the -r option, the first and second columns contain the closest matching reference transcript to the one described by each row. | |
| 174 | |
| 175 Here's an example of a line from the tracking file:: | |
| 176 | |
| 177 TCONS_00000045 XLOC_000023 Tcea|uc007afj.1 j \ | |
| 178 q1:exp.115|exp.115.0|100|3.061355|0.350242|0.350207 \ | |
| 179 q2:60hr.292|60hr.292.0|100|4.094084|0.000000|0.000000 | |
| 180 | |
| 181 In this example, a transcript present in the two input files, called exp.115.0 in the first and 60hr.292.0 in the second, doesn't match any reference transcript exactly, but shares exons with uc007afj.1, an isoform of the gene Tcea, as indicated by the class code j. The first three columns are as follows:: | |
| 182 | |
| 183 Column number Column name Example Description | |
| 184 ----------------------------------------------------------------------- | |
| 185 1 Cufflinks transfrag id TCONS_00000045 A unique internal id for the transfrag | |
| 186 2 Cufflinks locus id XLOC_000023 A unique internal id for the locus | |
| 187 3 Reference gene id Tcea The gene_name attribute of the reference GTF record for this transcript, or '-' if no reference transcript overlaps this Cufflinks transcript | |
| 188 4 Reference transcript id uc007afj.1 The transcript_id attribute of the reference GTF record for this transcript, or '-' if no reference transcript overlaps this Cufflinks transcript | |
| 189 5 Class code c The type of match between the Cufflinks transcripts in column 6 and the reference transcript. See class codes | |
| 190 | |
| 191 Each of the columns after the fifth have the following format: | |
| 192 qJ:gene_id|transcript_id|FMI|FPKM|conf_lo|conf_hi | |
| 193 | |
| 194 A transcript need be present in all samples to be reported in the tracking file. A sample not containing a transcript will have a "-" in its entry in the row for that transcript. | |
| 195 | |
| 196 Class Codes | |
| 197 | |
| 198 If you ran cuffcompare with the -r option, tracking rows will contain the following values. If you did not use -r, the rows will all contain "-" in their class code column:: | |
| 199 | |
| 200 Priority Code Description | |
| 201 --------------------------------- | |
| 202 1 = Match | |
| 203 2 c Contained | |
| 204 3 j New isoform | |
| 205 4 e A single exon transcript overlapping a reference exon and at least 10 bp of a reference intron, indicating a possible pre-mRNA fragment. | |
| 206 5 i A single exon transcript falling entirely with a reference intron | |
| 207 6 r Repeat. Currently determined by looking at the reference sequence and applied to transcripts where at least 50% of the bases are lower case | |
| 208 7 p Possible polymerase run-on fragment | |
| 209 8 u Unknown, intergenic transcript | |
| 210 9 o Unknown, generic overlap with reference | |
| 211 10 . (.tracking file only, indicates multiple classifications) | |
| 212 | |
| 213 ------- | |
| 214 | |
| 215 **Settings** | |
| 216 | |
| 217 All of the options have a default value. You can change any of them. Most of the options in Cuffcompare have been implemented here. | |
| 218 | |
| 219 ------ | |
| 220 | |
| 221 **Cuffcompare parameter list** | |
| 222 | |
| 223 This is a list of implemented Cuffcompare options:: | |
| 224 | |
| 225 -r An optional "reference" annotation GTF. Each sample is matched against this file, and sample isoforms are tagged as overlapping, matching, or novel where appropriate. See the refmap and tmap output file descriptions below. | |
| 226 -R If -r was specified, this option causes cuffcompare to ignore reference transcripts that are not overlapped by any transcript in one of cuff1.gtf,...,cuffN.gtf. Useful for ignoring annotated transcripts that are not present in your RNA-Seq samples and thus adjusting the "sensitivity" calculation in the accuracy report written in the transcripts_accuracy file | |
| 227 </help> | |
| 228 </tool> |