annotate ctat_star_fusion.xml @ 0:a530fa18e9e8 draft default tip

Upload ctat tools.
author trinity_ctat
date Tue, 17 Jul 2018 11:51:50 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
1 <tool id="ctat_star_fusion" name="ctat_star_fusion" version="1.0.1" profile="17.05">
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
2
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
3 <description>Fusion-finding Pipeline Using the STAR Aligner</description>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
4 <requirements>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
5 <requirement type="package" version="1.4.0">star-fusion</requirement>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
6 </requirements>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
7 <!-- Using command's detect_errors instead of below.
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
8 <stdio>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
9 <exit_code range="1:" level="fatal" description="Error returned from pipeline" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
10 </stdio>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
11 <regex match="Must investigate error above."
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
12 source="stderr"
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
13 level="fatal"
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
14 description="Unknown error encountered" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
15 -->
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
16 <command detect_errors="default">
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
17 <![CDATA[
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
18 STAR-Fusion
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
19 --genome_lib_dir "${genome_resource_lib.fields.path}"
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
20 --left_fq "${left_input}"
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
21 --right_fq "${right_input}"
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
22 --output_dir subdir
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
23 --STAR_SortedByCoordinate
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
24 ]]>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
25 </command>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
26
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
27 <inputs>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
28 <param format="fastq" name="left_input" type="data" label="Left/Forward strand reads" help=""/>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
29 <param format="fastq" name="right_input" type="data" label="Right/Reverse strand reads" help=""/>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
30 <param name="genome_resource_lib" type="select" label="Select a reference genome">
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
31 <options from_data_table="ctat_genome_resource_libs">
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
32 <filter type="sort_by" column="2" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
33 <validator type="no_options" message="No indexes are available" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
34 </options>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
35 </param>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
36 </inputs>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
37
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
38 <outputs>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
39 <data format="txt" name="starfusion_log" label="${tool.name} on ${on_string}: log" from_work_dir="subdir/Log.out"/>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
40 <data format="bam" name="aligned_bam" label="${tool.name} on ${on_string}: Aligned Bam" from_work_dir="subdir/std.STAR.bam"/>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
41 <data format="tabular" name="candidates" label="${tool.name} on ${on_string}: Fusion candidates" from_work_dir="subdir/star-fusion.fusion_predictions.abridged.tsv"/>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
42 <data format="tabular" name="chimeric_junc" label="${tool.name} on ${on_string}: Chimeric.out.junction" from_work_dir="subdir/std.Chimeric.out.junction"/>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
43 </outputs>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
44 <tests>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
45 <test>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
46 <param name="left_input" value="StarFusion/reads_1.fq.gz" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
47 <param name="right_input" value="StarFusion/reads_2.fq.gz" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
48 <!--
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
49 <param name="left_input" value="reads.left.simPE.fq" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
50 <param name="right_input" value="reads.right.simPE.fq" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
51 -->
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
52 <!-- FIX - now that we added the CTAT ref lib path as a parameter, how do we find it for testing?
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
53 <param name="genome_resource_lib.fields.path" value="?????" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
54 -->
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
55 <!--
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
56 <output name="aligned_bam" file="SF_out_aligned.bam" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
57 <output name="candidates" file="SF_out_fusion_candidates.dat" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
58 <output name="chimeric_junc" file="SF_out_chimeric.junction" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
59 <output name="starfusion_log" file="SF_out.log" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
60 -->
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
61 <output name="starfusion_log">
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
62 <assert_contents>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
63 <has_line_matching expression=".+" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
64 <has_line line="ALL DONE!" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
65 </assert_contents>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
66 </output>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
67 <output name="aligned_bam">
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
68 <assert_contents>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
69 <has_line_matching expression=".+" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
70 <!-- The following checks for the magic number at the start of the bam file -->
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
71 <!-- At first I thought "\x8B\x1F" was the number, but it turns out the file
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
72 produced by the StarFusion test had that sequence in the file somewhere else.
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
73 -->
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
74 <has_text_matching expression="\x1F\x8B" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
75 </assert_contents>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
76 </output>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
77 <output name="candidates">
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
78 <assert_contents>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
79 <has_line_matching expression=".+" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
80 <has_line line="#fusion_name&#009;JunctionReads&#009;SpanningFrags&#009;Splice_type&#009;LeftGene&#009;LeftBreakpoint&#009;RightGene&#009;RightBreakpoint&#009;Long_double_anchor_support" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
81 </assert_contents>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
82 </output>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
83 <output name="chimeric_junc">
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
84 <assert_contents>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
85 <has_line_matching expression=".+" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
86 <has_line_matching expression="^chr20.*" />
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
87 </assert_contents>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
88 </output>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
89 </test>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
90 </tests>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
91 <help>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
92 .. class:: infomark
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
93
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
94 STAR-Fusion is a component of the Trinity Cancer Transcriptome Analysis Toolkit (CTAT). STAR-Fusion uses the STAR aligner to identify candidate fusion transcripts supported by Illumina reads. STAR-Fusion further processes the output generated by the STAR aligner to map junction reads and spanning reads to a reference annotation set. Please read more here_.
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
95
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
96 .. _here: https://github.com/STAR-Fusion/STAR-Fusion/wiki
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
97
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
98 </help>
a530fa18e9e8 Upload ctat tools.
trinity_ctat
parents:
diff changeset
99 </tool>