annotate README @ 36:82779d2aacdd draft

Uploaded
author brasset_jensen
date Sun, 17 Jun 2018 16:39:58 -0400
parents b3be854a4273
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
1
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
2 Description
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
3 =============
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
4
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
5 The field of small RNA is one of the most investigated research areas since they were shown to regulate gene expression and play essential roles in fundamental biological processes.
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
6 sRNAPipe a computational pipeline (sRNAPipe: small RNA pipeline) based on the Galaxy framework that takes as input a fastq file of small RNA-seq reads and performs successive steps of mapping to categories of genomic sequences: microRNAs, gene transcripts, small nuclear RNAs, ribosomal RNAs, transfer RNAs and transposable elements. It also provides individual mapping and counting for chromosomes, gene transcripts and transposable elements, normalization, small RNA length analysis and plotting of the data along genomic coordinates to build publication-quality graphs and figures. sRNAPipe evaluates 10-nucleotide 5’-overlaps of reads on opposite strands to test ping-pong amplification for putative PIWI-interacting RNAs, providing numbers of overlaps and corresponding z-scores.
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
7
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
8
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
9
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
10 Prerequisites
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
11 =============
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
12
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
13 1. Unix system with A Galaxy server (release july 2014 or later installed)
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
14
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
15 2. Some tools are used by sRNAPipe and must be installed and added to the Path.
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
16
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
17 * Bwa aligner: you can obtain it here: https://sourceforge.net/projects/bio-bwa/files/ . Please download version 0.7.12-r1039 or higher
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
18 * BedTools powerful toolset for genome arithmetic is also needed. It should be found here: http://bedtools.readthedocs.io/en/latest/ . We recommend to use v2.24.0 or higher.
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
19 * Samtools : you can obtain it here : https://sourceforge.net/projects/samtools/files/samtools/1.2/. Please download version 1.2
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
20
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
21 3. Perl version higher than 5.1 is needed with packages : "perl-statistics", "Parallel::ForkManager", "Statistics::R", "Getopt::Long" , "String::Random" installed.
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
22
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
23 4. R project version higher than 3.1 is needed with libraries "plotrix", "bioconductor-sushi", "RColorBrewer" and "ggplot2" installed. You can find respectively these libraries here: https://cran.r-project.org/web/packages/plotrix/index.html and https://bioconductor.org/packages/release/bioc/html/Sushi.html and https://cran.r-project.org/web/packages/RColorBrewer/index.html and https://cran.r-project.org/web/packages/ggplot2/index.html
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
24
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
25 Installation
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
26 =============
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
27
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
28 The process has to be completed by an administrator of your Galaxy server to install sRNAPipe.
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
29
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
30 1. Download sRNAPipe
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
31 You can find sRNAPipe here: https://github.com/brassetjensen/sRNAPipe
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
32
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
33 2. Put the tool into Galaxy's tools directory
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
34 You need to add files into tools/ directory , where all tool-related files are stored, within your Galaxy installation.
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
35
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
36 3. Make Galaxy aware of the new tool sRNAPipe
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
37 Now that the tool and its definition file are ready, the final step is to make Galaxy aware of the new files.
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
38 Galaxy recognizes installed tools by reading the tool_conf.xml tool configuration file. Thus, letting Galaxy know about the new tool is as easy as adding a few lines to the tool_conf.xml file located in the config/ directory of the Galaxy installation. New tools can either be added to existing sections or added to new sections defined in the following way:
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
39
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
40 ```xml
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
41 <section name="NewTools" id="mTools">
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
42 <tool file="sRNAPipe.xml" />
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
43 </section>
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
44 ```
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
45
b3be854a4273 Uploaded
brasset_jensen
parents:
diff changeset
46 4. Start or Restart Galaxy to use it.