annotate rsem_prepare_reference.xml @ 2:67c078448bea draft

Uploaded
author yboursin
date Fri, 21 Oct 2016 08:51:23 -0400
parents 73a9e9df80da
children e5c7c06fd762
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
73a9e9df80da Uploaded
yboursin
parents: 0
diff changeset
1 <tool id="rsem_prepare_reference" name="RSEM prepare reference" version="EBA2016-v1">
0
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
2 <description></description>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
3 <requirements>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
4 <requirement type="package" version="1.2.28">rsem</requirement>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
5 <requirement type="package" version="1.1.2">bowtie</requirement>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
6 <requirement type="package" version="2.2.6">bowtie2</requirement>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
7 </requirements>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
8 <command>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
9 echo $reference_name " " | tee $reference_file &amp;&amp;
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
10 mkdir $reference_file.files_path &amp;&amp;
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
11 cd $reference_file.files_path &amp;&amp;
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
12 rsem-prepare-reference
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
13 #if $polya.polya_use == 'add':
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
14 #if $polya.polya_length:
2
67c078448bea Uploaded
yboursin
parents: 1
diff changeset
15 --polyA --polyA-length $polya.polya_length
0
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
16 #end if
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
17 #elif $polya.polya_use == 'subset':
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
18 --no-polyA-subset $polya.no_polya_subset
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
19 #if $polya.polya_length:
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
20 --polyA-length $polya.polya_length
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
21 #end if
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
22 $ntog
1
73a9e9df80da Uploaded
yboursin
parents: 0
diff changeset
23 $bowtie
73a9e9df80da Uploaded
yboursin
parents: 0
diff changeset
24 $bowtietwo
0
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
25 #if $transcript_to_gene_map:
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
26 --transcript-to-gene-map $transcript_to_gene_map
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
27 #end if
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
28 #if $reference.ref_type == 'transcripts':
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
29 $reference.reference_fasta_file
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
30 #else:
1
73a9e9df80da Uploaded
yboursin
parents: 0
diff changeset
31 #if $reference.gtf.extension == 'gtf':
0
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
32 --gtf $reference.gtf
1
73a9e9df80da Uploaded
yboursin
parents: 0
diff changeset
33 #elif $reference.gtf.extension == 'gff3':
73a9e9df80da Uploaded
yboursin
parents: 0
diff changeset
34 --gff3 $reference.gtf
73a9e9df80da Uploaded
yboursin
parents: 0
diff changeset
35 #end if
0
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
36 $reference.reference_fasta_file
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
37 #end if
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
38 $reference_name
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
39 > ${reference_name}.log
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
40 </command>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
41 <inputs>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
42 <conditional name="reference">
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
43 <param name="ref_type" type="select" label="Reference transcript source">
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
44 <option value="transcripts">transcript fasta</option>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
45 <option value="genomic">reference genome and gtf</option>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
46 </param>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
47 <when value="transcripts">
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
48 <param name="reference_fasta_file" type="data" format="fasta" label="reference fasta file"
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
49 help="The files should contain the sequences of transcripts."/>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
50 </when>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
51 <when value="genomic">
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
52 <param name="reference_fasta_file" type="data" format="fasta" label="reference fasta file"
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
53 help="The file should contain the sequence of an entire genome."/>
1
73a9e9df80da Uploaded
yboursin
parents: 0
diff changeset
54 <param name="gtf" type="data" format="gtf,gff3" label="gtf or gff3 file"
73a9e9df80da Uploaded
yboursin
parents: 0
diff changeset
55 help="extract transcript reference sequences using the gene annotations specified in this GTF or GFF3 file" />
0
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
56 </when>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
57 </conditional>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
58 <param name="transcript_to_gene_map" type="data" format="tabular" optional="true" label="Map of gene ids to transcript (isoform) ids" >
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
59 <help>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
60 Each line of should be of the form: gene_id transcript_id ( with the two fields separated by a tab character )
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
61 The map can be obtained from the UCSC table browser
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
62 group: Genes and Gene Prediction Tracks
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
63 table: knownIsoforms
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
64 Without a map:
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
65 If a reference genome and gtf is used, then RSEM uses the "gene_id" and "transcript_id" attributes in the GTF file.
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
66 Otherwise, RSEM assumes that each sequence in the reference sequence files is a separate gene.
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
67 </help>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
68 </param>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
69 <param name="reference_name" type="text" value="rsem_ref_name" label="reference name">
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
70 <help>A one word name for this RSEM reference containing only letters, digits, and underscore characters</help>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
71 <validator type="regex" message="Use only letters, digits, and underscore characters">^\w+$</validator>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
72 </param>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
73 <conditional name="polya">
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
74 <param name="polya_use" type="select" label="PolyA ">
2
67c078448bea Uploaded
yboursin
parents: 1
diff changeset
75 <option value="add">Add poly(A) tails to all transcripts</option>
0
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
76 <option value="subset">Exclude poly(A) tails from selected transcripts</option>
2
67c078448bea Uploaded
yboursin
parents: 1
diff changeset
77 <option value="none" selected="true">Do not add poly(A) tails to any transcripts</option>
0
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
78 </param>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
79 <when value="add">
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
80 <param name="polya_length" type="integer" value="125" optional="true" label="The length of the poly(A) tails to be added. (Default: 125)">
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
81 <validator type="in_range" message="must be positive " min="1"/>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
82 </param>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
83 </when>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
84 <when value="subset">
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
85 <param name="no_polya_subset" type="data" format="tabular" optional="true" label="List of transcript IDs (one per line) that should should not have polyA tails added."/>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
86 <param name="polya_length" type="integer" value="125" optional="true" label="The length of the poly(A) tails to be added. (Default: 125)">
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
87 <validator type="in_range" message="must be positive " min="1"/>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
88 </param>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
89 </when>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
90 <when value="none"/>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
91 </conditional>
1
73a9e9df80da Uploaded
yboursin
parents: 0
diff changeset
92 <param name="bowtie" type="boolean" truevalue="--bowtie" falsevalue="" checked="false" label="Use bowtie" />
73a9e9df80da Uploaded
yboursin
parents: 0
diff changeset
93 <param name="bowtietwo" type="boolean" truevalue="--bowtie2" falsevalue="" checked="false" label="Use bowtie2" />
0
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
94 <param name="ntog" type="boolean" truevalue="--no-ntog" falsevalue="" checked="false" label="Disable the conversion of 'N' characters to 'G' characters in the reference sequences" help="Bowite uses the automatic N to G conversion to to align against all positions in the reference."/>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
95 </inputs>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
96 <stdio>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
97 <exit_code range="1:" level="fatal" description="Error Running RSEM" />
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
98 </stdio>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
99 <outputs>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
100 <data format="rsem_ref" name="reference_file" label="RSEM ${reference_name} reference"/>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
101 </outputs>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
102 <tests>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
103 <test>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
104 <param name="ref_type" value="genomic"/>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
105 <param name="reference_fasta_file" value="ref.fasta" ftype="fasta"/>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
106 <param name="gtf" value="ref.gtf" ftype="gtf"/>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
107 <param name="reference_name" value="ref"/>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
108 <output name="rsem_ref">
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
109 <assert_contents>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
110 <has_text text="ref.grp" />
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
111 </assert_contents>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
112 </output>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
113 </test>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
114 </tests>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
115 <help>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
116
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
117 RSEM HOME PAGE - http://deweylab.biostat.wisc.edu/rsem/
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
118
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
119 NAME
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
120 rsem-prepare-reference
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
121
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
122 SYNOPSIS
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
123 rsem-prepare-reference [options] reference_fasta_file(s) reference_name
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
124
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
125 DESCRIPTION
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
126 The rsem-prepare-reference program extracts/preprocesses the reference sequences and builds Bowtie indices using default parameters.
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
127 This program is used in conjunction with the 'rsem-calculate-expression' program.
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
128
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
129 INPUTS
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
130 A fasta file of transcripts
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
131 or
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
132 A genome sequence fasta file and a GTF gene annotation file. (When using UCSC data, include the related knownIsoforms.txt)
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
133
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
134 </help>
7146e81bc886 Uploaded
yboursin
parents:
diff changeset
135 </tool>