annotate README.rst @ 4:05c9b1a7f44e draft default tip

Uploaded new release 1.7.3

======================================================================================
SARTools-Galaxy: a galaxy wrapper for SARTools (Statistical Analysis of RNA-Seq Tools)
======================================================================================

|Build Status|

Description:
============


SARTools is a R package dedicated to the differential analysis of RNA-seq data.

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.

SARTools can be downloaded on github (https://github.com/PF2-pasteur-fr/SARTools). More information about installation can be found at this url.


Requirements using Conda:
=========================

|install with bioconda|

`Conda`_ is a package manager that among many other things can be used to manage Python packages.

.. code-block:: bash

   #To install miniconda
   #http://conda.pydata.org/miniconda.html
   #To install the SARTools R library using conda:
   conda install r-sartools
   #To set an environment:
   conda create -n r-sartools r-sartools`
   #To activate the environment:
   . activate r-sartools

Test:
=====

``planemo test`` using conda: passed

References:
===========


The SARTools package has been developped at PF2 - Institut Pasteur by M.-A. Dillies and H. Varet ([e-mail]).

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.

The Galaxy wrapper and scripts have been developped by Loraine Brillet-Guéguen, Institut Français de Bioinformatique

.. _Conda: http://conda.pydata.org/

.. |Build Status| image:: https://travis-ci.org/PF2-pasteur-fr/SARTools-Galaxy.svg?branch=master
   :target: https://travis-ci.org/PF2-pasteur-fr/SARTools-Galaxy

.. |install with bioconda| image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat
   :target: http://bioconda.github.io/recipes/r-sartools/README.html