annotate README.md @ 2:d86ccac2a660 draft

New release of SARTools (1.3.2)
author lgueguen
date Wed, 17 May 2017 05:09:10 -0400
parents 581d217c7337
children de6d0b7c17af
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
1 -----------------------------------------------------------
2
d86ccac2a660 New release of SARTools (1.3.2)
lgueguen
parents: 0
diff changeset
2 SARTools-Galaxy: a galaxy wrapper for SARTools version 1.3.2
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
3 -----------------------------------------------------------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
4
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
5 [![Build Status](https://travis-ci.org/PF2-pasteur-fr/SARTools-Galaxy.svg?branch=master)](https://travis-ci.org/PF2-pasteur-fr/SARTools-Galaxy)
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
6
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
7 Description:
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
8 ------------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
9 SARTools is a R package dedicated to the differential analysis of RNA-seq data.
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
10
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
11 SARTools provides tools to generate descriptive and diagnostic graphs, to run the differential analysis with one of the well known DESeq2 or edgeR packages and to export the results into easily readable tab-delimited files. It also facilitates the generation of a HTML report which displays all the figures produced, explains the statistical methods and gives the results of the differential analysis. Note that SARTools does not intend to replace DESeq2 or edgeR: it simply provides an environment to go with them. For more details about the methodology behind DESeq2 or edgeR, the user should read their documentations and papers.
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
12
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
13 Requirements:
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
14 -------------
2
d86ccac2a660 New release of SARTools (1.3.2)
lgueguen
parents: 0
diff changeset
15 R (3.3.0 or higher), Bio-conductor package
d86ccac2a660 New release of SARTools (1.3.2)
lgueguen
parents: 0
diff changeset
16 SARTools package (1.3.2)
d86ccac2a660 New release of SARTools (1.3.2)
lgueguen
parents: 0
diff changeset
17 other R packages: DESeq2 (1.12.0 or higher), edgeR (3.12.0 or higher), genefilter, xtable and knitr
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
18 Rscript
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
19
2
d86ccac2a660 New release of SARTools (1.3.2)
lgueguen
parents: 0
diff changeset
20 SARTools can be downloaded on github (https://github.com/PF2-pasteur-fr/SARTools). More information about installation can be found at this url.
0
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
21
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
22 Requirements using Conda:
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
23 -------------------------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
24 [![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/r-sartools/README.html)
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
25
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
26 [Conda](http://conda.pydata.org/) is package manager that among many other things can be used to manage Python packages.
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
27
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
28
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
29 ```
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
30 #To install miniconda2
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
31 #http://conda.pydata.org/miniconda.html
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
32 #To install the SARTools R library using conda:
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
33 conda install r-sartools
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
34 #To set an environment:
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
35 conda create -n r-sartools r-sartools`
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
36 #To activate the environment:
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
37 . activate r-sartools
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
38 ```
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
39
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
40
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
41 Test:
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
42 -----
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
43
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
44 `planemo test` using conda: passed
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
45
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
46
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
47 References:
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
48 -----------
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
49 The SARTools package has been developped at PF2 - Institut Pasteur by M.-A. Dillies and H. Varet (hugo.varet@pasteur.fr).
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
50 Thanks to cite H. Varet, L. Brillet-Guéguen, J.-Y. Coppee and M.-A. Dillies, SARTools: A DESeq2- and EdgeR-Based R Pipeline for Comprehensive Differential Analysis of RNA-Seq Data, PLoS One, 2016, doi: http://dx.doi.org/10.1371/journal.pone.0157022 when using this tool for any analysis published.
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
51
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
52 The Galaxy wrapper and scripts have been developped by Loraine Brillet-Guéguen, Institut Français de Bioinformatique
581d217c7337 Planemo upload
lgueguen
parents:
diff changeset
53