annotate star_fusion.xml @ 3:b9aeea129597 draft

Uploaded
author trinity_ctat
date Fri, 15 Dec 2017 14:22:41 -0500
parents f90885dda34c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
f90885dda34c Adding star_fusion tool.
trinity_ctat
parents: 0
diff changeset
1 <tool id="star_fusion" name="Star Fusion" version="1.0.0" profile="17.05">
0
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
2 <description>Fusion-finding Pipeline Using the STAR Aligner</description>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
3 <requirements>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
4 <requirement type="package" version="1.1.0">star-fusion</requirement>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
5 </requirements>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
6 <command detect_errors="default">
2
f90885dda34c Adding star_fusion tool.
trinity_ctat
parents: 0
diff changeset
7 <![CDATA[
f90885dda34c Adding star_fusion tool.
trinity_ctat
parents: 0
diff changeset
8 STAR-Fusion
f90885dda34c Adding star_fusion tool.
trinity_ctat
parents: 0
diff changeset
9 --genome_lib_dir "${genome_ref_lib.fields.path}"
f90885dda34c Adding star_fusion tool.
trinity_ctat
parents: 0
diff changeset
10 --left_fq "${left_input}
f90885dda34c Adding star_fusion tool.
trinity_ctat
parents: 0
diff changeset
11 --right_fq "${right_input}
f90885dda34c Adding star_fusion tool.
trinity_ctat
parents: 0
diff changeset
12 --output_dir subdir
f90885dda34c Adding star_fusion tool.
trinity_ctat
parents: 0
diff changeset
13 ]]>
0
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
14 </command>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
15 <stdio>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
16 <exit_code range="1:" level="fatal" description="Error returned from pipeline" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
17 </stdio>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
18 <regex match="Must investigate error above."
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
19 source="stderr"
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
20 level="fatal"
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
21 description="Unknown error encountered" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
22 <inputs>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
23 <param format="fastq" name="left_input" type="data" label="Left/Forward strand reads" help=""/>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
24 <param format="fastq" name="right_input" type="data" label="Right/Reverse strand reads" help=""/>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
25 <param name="genome_ref_lib" type="select" label="Select a reference genome">
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
26 <options from_data_table="ctat_genome_ref_libs">
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
27 <filter type="sort_by" column="2" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
28 <validator type="no_options" message="No indexes are available" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
29 </options>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
30 </param>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
31
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
32 </inputs>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
33 <outputs>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
34 <data format="txt" name="starfusion_log" label="${tool.name} on ${on_string}: log" from_work_dir="subdir/Log.out"/>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
35 <data format="bam" name="aligned_bam" label="${tool.name} on ${on_string}: Aligned Bam" from_work_dir="subdir/Aligned.sortedByCoord.out.bam"/>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
36 <data format="tabular" name="candidates" label="${tool.name} on ${on_string}: Fusion candidates" from_work_dir="subdir/star-fusion.fusion_candidates.final.abridged"/>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
37 <data format="tabular" name="chimeric_junc" label="${tool.name} on ${on_string}: Chimeric.out.junction" from_work_dir="subdir/Chimeric.out.junction"/>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
38 </outputs>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
39 <tests>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
40 <test>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
41 <param name="left_input" value="StarFusion/reads_1.fq.gz" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
42 <param name="right_input" value="StarFusion/reads_2.fq.gz" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
43 <!--
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
44 <param name="left_input" value="reads.left.simPE.fq" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
45 <param name="right_input" value="reads.right.simPE.fq" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
46 -->
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
47 <!--
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
48 <output name="aligned_bam" file="SF_out_aligned.bam" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
49 <output name="candidates" file="SF_out_fusion_candidates.dat" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
50 <output name="chimeric_junc" file="SF_out_chimeric.junction" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
51 <output name="starfusion_log" file="SF_out.log" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
52 -->
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
53 <output name="starfusion_log">
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
54 <assert_contents>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
55 <has_line_matching expression=".+" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
56 <has_line line="ALL DONE!" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
57 </assert_contents>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
58 </output>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
59 <output name="aligned_bam">
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
60 <assert_contents>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
61 <has_line_matching expression=".+" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
62 <!-- The following checks for the magic number at the start of the bam file -->
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
63 <!-- At first I thought "\x8B\x1F" was the number, but it turns out the file
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
64 produced by the StarFusion test had that sequence in the file somewhere else.
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
65 -->
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
66 <has_text_matching expression="\x1F\x8B" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
67 </assert_contents>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
68 </output>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
69 <output name="candidates">
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
70 <assert_contents>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
71 <has_line_matching expression=".+" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
72 <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" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
73 </assert_contents>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
74 </output>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
75 <output name="chimeric_junc">
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
76 <assert_contents>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
77 <has_line_matching expression=".+" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
78 <has_line_matching expression="^chr20.*" />
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
79 </assert_contents>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
80 </output>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
81 </test>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
82 </tests>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
83 <help>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
84 .. class:: infomark
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
85
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
86 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_.
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
87
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
88 .. _here: https://github.com/STAR-Fusion/STAR-Fusion/wiki
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
89
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
90 </help>
a01db6debed5 Adding star_fusion tool.
trinity_ctat
parents:
diff changeset
91 </tool>