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

Uploaded new release 1.7.3
author lgueguen
date Thu, 07 Jan 2021 11:12:01 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
1 ======================================================================================
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
2 SARTools-Galaxy: a galaxy wrapper for SARTools (Statistical Analysis of RNA-Seq Tools)
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
3 ======================================================================================
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
4
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
5 |Build Status|
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
6
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
7 Description:
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
8 ============
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
9
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
10
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
11 SARTools is a R package dedicated to the differential analysis of RNA-seq data.
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
12
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
13 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.
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
14
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
15 SARTools can be downloaded on github (https://github.com/PF2-pasteur-fr/SARTools). More information about installation can be found at this url.
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
16
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
17
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
18 Requirements using Conda:
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
19 =========================
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
20
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
21 |install with bioconda|
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
22
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
23 `Conda`_ is a package manager that among many other things can be used to manage Python packages.
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
24
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
25 .. code-block:: bash
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
26
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
27 #To install miniconda
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
28 #http://conda.pydata.org/miniconda.html
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
29 #To install the SARTools R library using conda:
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
30 conda install r-sartools
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
31 #To set an environment:
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
32 conda create -n r-sartools r-sartools`
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
33 #To activate the environment:
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
34 . activate r-sartools
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
35
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
36 Test:
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
37 =====
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
38
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
39 ``planemo test`` using conda: passed
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
40
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
41 References:
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
42 ===========
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
43
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
44
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
45 The SARTools package has been developped at PF2 - Institut Pasteur by M.-A. Dillies and H. Varet (hugo.varet@pasteur.fr).
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
46
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
47 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.
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
48
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
49 The Galaxy wrapper and scripts have been developped by Loraine Brillet-Guéguen, Institut Français de Bioinformatique
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
50
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
51 .. _Conda: http://conda.pydata.org/
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
52
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
53 .. |Build Status| image:: https://travis-ci.org/PF2-pasteur-fr/SARTools-Galaxy.svg?branch=master
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
54 :target: https://travis-ci.org/PF2-pasteur-fr/SARTools-Galaxy
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
55
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
56 .. |install with bioconda| image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat
05c9b1a7f44e Uploaded new release 1.7.3
lgueguen
parents:
diff changeset
57 :target: http://bioconda.github.io/recipes/r-sartools/README.html