annotate README.md @ 52:b62dc0435760 draft

Uploaded
author pierre.pouchin
date Thu, 06 Sep 2018 11:59:18 -0400
parents 4bc00caa60b4
children e12ad81abcbb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
40
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
1 # sRNAPipe
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
2 a GALAXY-based pipeline for bioinformatic in-depth exploration of small RNA-seq data
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
3
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
4 Description
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
5 =============
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
6
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
7 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.
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
8 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.
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
9
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
10
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
11
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
12 Prerequisites
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
13 =============
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
14
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
15 1. Unix system with A Galaxy server (release july 2014 or later installed)
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
16
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
17 2. Some tools are used by sRNAPipe and must be installed and added to the Path.
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
18
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
19 * Bwa aligner: you can obtain it here: https://sourceforge.net/projects/bio-bwa/files/ . Please download version 0.7.12-r1039 or higher
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
20 * 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.
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
21 * Samtools : you can obtain it here : https://sourceforge.net/projects/samtools/files/samtools/1.2/. Please download version 1.2
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
22
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
23 3. Perl version higher than 5.1 is needed with packages : "perl-statistics", "Parallel::ForkManager", "Statistics::R", "Getopt::Long" , "String::Random" installed.
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
24
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
25 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
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
26
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
27 Installation
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
28 =============
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
29
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
30 The process has to be completed by an administrator of your Galaxy server to install sRNAPipe.
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
31
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
32 1. Download sRNAPipe
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
33 You can find sRNAPipe here: https://github.com/brassetjensen/sRNAPipe
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
34
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
35 2. Put the tool into Galaxy's tools directory
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
36 You need to add files into tools/ directory , where all tool-related files are stored, within your Galaxy installation.
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
37
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
38 3. Make Galaxy aware of the new tool sRNAPipe
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
39 Now that the tool and its definition file are ready, the final step is to make Galaxy aware of the new files.
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
40 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:
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
41
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
42 ```xml
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
43 <section name="NewTools" id="mTools">
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
44 <tool file="sRNAPipe.xml" />
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
45 </section>
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
46 ```
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
47
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
48 4. Start or Restart Galaxy to use it.
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
49
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
50 User Manual
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
51 =============
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
52
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
53 <object data="https://github.com/brassetjensen/sRNAPipe/blob/master/sRNAPipe_User_Manual.pdf" type="application/pdf" width="700px" height="700px">
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
54 <embed src="https://github.com/brassetjensen/sRNAPipe/blob/master/sRNAPipe_User_Manual.pdf">
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
55 This browser does not support PDFs. Please download the PDF to view it: <a href="https://github.com/brassetjensen/sRNAPipe/blob/master/sRNAPipe_User_Manual.pdf">Download PDF</a>.</p>
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
56 </embed>
4bc00caa60b4 Uploaded
pierre.pouchin
parents:
diff changeset
57 </object>