annotate ngsderive_strandedness.xml @ 0:bb8409cb3005 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
author iuc
date Fri, 09 Jan 2026 09:57:07 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
1 <tool id="ngsderive_strandedness" name="ngsderive strandedness" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="23.0">
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
2 <description>infers strandedness from RNA-seq BAM files</description>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
3 <macros>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
4 <token name="@TOOL_VERSION@">4.0.0</token>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
5 <token name="@VERSION_SUFFIX@">0</token>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
6 </macros>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
7 <requirements>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
8 <requirement type="package" version="@TOOL_VERSION@">ngsderive</requirement>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
9 </requirements>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
11 ln -s '${alignment_input}' input.bam &&
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
12 ln -s '${alignment_input.metadata.bam_index}' input.bam.bai &&
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
13 ln -s '${gtf_input}' annotation.${gtf_input.ext} &&
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
14
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
15 ngsderive strandedness
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
16 input.bam
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
17 -g annotation.${gtf_input.ext}
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
18 -n $n_genes
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
19 -m $min_reads_per_gene
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
20 -q $mapq
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
21 $split_by_rg
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
22 > '${output}'
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
23 ]]></command>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
24 <inputs>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
25 <param name="alignment_input" type="data" format="bam" label="Input alignment file" help="Aligned paired-end RNA-seq reads in BAM format."/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
26 <param name="gtf_input" type="data" format="gtf,gtf.gz" label="Gene annotation file (GTF)" help="Gene model in GTF format. The file will be automatically sorted and indexed if necessary."/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
27 <param argument="-n" name="n_genes" type="integer" value="1000" min="1" label="Number of genes to sample" help="Number of random genes to sample for strandedness inference."/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
28 <param argument="-m" name="min_reads_per_gene" type="integer" value="10" min="1" label="Minimum reads per gene" help="Minimum number of reads per gene required for inclusion in the analysis."/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
29 <param argument="-q" name="mapq" type="integer" value="30" min="0" label="Minimum mapping quality (MAPQ)" help="Minimum MAPQ score for a read to be considered."/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
30 <param argument="--split-by-rg" type="boolean" truevalue="--split-by-rg" falsevalue="" checked="false" label="Split results by read group" help="Output one entry per read group in addition to an overall entry."/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
31 </inputs>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
32 <outputs>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
33 <data name="output" format="tabular" label="${tool.name} on ${on_string}">
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
34 <actions>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
35 <action name="column_names" type="metadata" default="File,ReadGroup,TotalReads,ForwardPct,ReversePct,Predicted"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
36 </actions>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
37 </data>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
38 </outputs>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
39 <tests>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
40 <!-- Test forward-stranded data -->
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
41 <test expect_num_outputs="1">
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
42 <param name="alignment_input" value="forward_stranded.bam"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
43 <param name="gtf_input" value="strandedness_test.gtf"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
44 <output name="output">
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
45 <assert_contents>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
46 <has_n_columns n="6"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
47 <has_text text="Stranded-Forward"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
48 </assert_contents>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
49 </output>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
50 </test>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
51 <!-- Test reverse-stranded data -->
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
52 <test expect_num_outputs="1">
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
53 <param name="alignment_input" value="reverse_stranded.bam"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
54 <param name="gtf_input" value="strandedness_test.gtf"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
55 <output name="output">
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
56 <assert_contents>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
57 <has_n_columns n="6"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
58 <has_text text="Stranded-Reverse"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
59 </assert_contents>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
60 </output>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
61 </test>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
62 <!-- Test unstranded data -->
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
63 <test expect_num_outputs="1">
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
64 <param name="alignment_input" value="unstranded.bam"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
65 <param name="gtf_input" value="strandedness_test.gtf"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
66 <output name="output">
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
67 <assert_contents>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
68 <has_n_columns n="6"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
69 <has_text text="Unstranded"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
70 </assert_contents>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
71 </output>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
72 </test>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
73 <!-- Test with gzipped GTF annotation file -->
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
74 <test expect_num_outputs="1">
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
75 <param name="alignment_input" value="reverse_stranded.bam"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
76 <param name="gtf_input" value="strandedness_test.gtf.gz" ftype="gtf.gz"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
77 <output name="output">
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
78 <assert_contents>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
79 <has_n_columns n="6"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
80 <has_text text="Stranded-Reverse"/>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
81 </assert_contents>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
82 </output>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
83 </test>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
84 </tests>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
85 <help><![CDATA[
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
86 **What it does**
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
87
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
88 ngsderive strandedness infers the strandedness protocol used to generate RNA-seq data by
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
89 analyzing read alignments against a gene model. It can determine whether your data was
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
90 generated using a Stranded-Forward, Stranded-Reverse, or Unstranded protocol.
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
91
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
92 This tool is useful when you have RNA-seq data but are unsure about the library preparation
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
93 protocol used. Knowing the correct strandedness is essential for accurate gene expression
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
94 quantification.
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
95
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
96 **How it works**
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
97
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
98 The tool randomly samples genes from the provided gene model and examines how reads align
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
99 to those genes. Based on the proportion of reads mapping in the forward vs reverse orientation,
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
100 it classifies the library as:
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
101
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
102 - **Unstranded**: ~40-60% forward reads
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
103 - **Stranded-Forward**: ≥80% forward reads
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
104 - **Stranded-Reverse**: ≥80% reverse reads
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
105 - **Inconclusive**: Results don't clearly indicate a strandedness type
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
106
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
107 **Inputs**
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
108
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
109 - **Alignment file**: Paired-end RNA-seq alignments in BAM format
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
110 - **Gene annotation**: GTF file with gene models (gzipped GTF supported)
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
111
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
112 **Output**
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
113
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
114 A tabular file with the following columns:
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
115
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
116 - **File**: Name of the input BAM file
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
117 - **ReadGroup**: Read group identifier (or "overall" for combined results)
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
118 - **TotalReads**: Number of reads used in the analysis
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
119 - **ForwardPct**: Percentage of reads supporting forward strandedness
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
120 - **ReversePct**: Percentage of reads supporting reverse strandedness
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
121 - **Predicted**: The inferred strandedness (Stranded-Forward, Stranded-Reverse, Unstranded, or Inconclusive)
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
122
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
123 **Notes**
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
124
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
125 - Only paired-end reads are currently supported
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
126 - For best results, ensure your BAM file has sufficient read depth
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
127
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
128 For more information, see the `ngsderive documentation <https://stjudecloud.github.io/ngsderive/subcommands/strandedness/>`_.
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
129 ]]></help>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
130 <citations>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
131 <citation type="bibtex">
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
132 @software{ngsderive,
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
133 author = {{St. Jude Cloud Team}},
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
134 title = {ngsderive: Forensic analysis tool for NGS data},
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
135 url = {https://github.com/stjudecloud/ngsderive},
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
136 year = {2020}
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
137 }
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
138 </citation>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
139 </citations>
bb8409cb3005 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ngsderive commit 431830f24865316ab81526f053c171abf9f09529
iuc
parents:
diff changeset
140 </tool>