Mercurial > repos > ethevenot > biosigner
annotate README.md @ 3:fa80bd02055f draft default tip
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit 23d58cfd97411ad5d272971896914ce99e30b0ab
author | ethevenot |
---|---|
date | Tue, 06 Jun 2017 11:44:00 -0400 |
parents | b2414be87d4b |
children |
rev | line source |
---|---|
0
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
1 Discovery of significant signatures from omics data |
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
2 =================================================== |
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
3 |
2
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
4 A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) infrastructure |
0
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
5 |
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
6 Status: [![Build Status](https://travis-ci.org/workflow4metabolomics/biosigner.svg?branch=master)](https://travis-ci.org/workflow4metabolomics/biosigner). |
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
7 |
2
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
8 ### Description |
0
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
9 |
2
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
10 **Version:** 2.2.6 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
11 **Date:** 2016-08-05 |
0
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
12 **Author:** Philippe Rinaudo and Etienne A. Thevenot (CEA, LIST, MetaboHUB, W4M Core Development Team) |
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
13 **Email:** [etienne.thevenot(at)cea.fr](mailto:etienne.thevenot@cea.fr) |
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
14 **Citation:** Rinaudo P., Boudah S., Junot C. and Thevenot E.A. (2015). biosigner: A new method for the discovery of restricted and stable molecular signatures from omics data. *Frontiers in Molecular Biosciences*, in review. |
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
15 **Licence:** CeCILL |
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
16 **Reference history:** [W4M00003_diaplasma](http://galaxy.workflow4metabolomics.org/history/list_published) |
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
17 **Funding:** Agence Nationale de la Recherche ([MetaboHUB](http://www.metabohub.fr/index.php?lang=en&Itemid=473) national infrastructure for metabolomics and fluxomics, ANR-11-INBS-0010 grant) |
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
18 |
2
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
19 ### Installation |
0
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
20 |
2
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
21 * Configuration file: `biosigner_config.xml` |
0
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
22 * Image files: |
2
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
23 + `static/images/biosigner_workflowPositionImage.png` |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
24 + `static/images/biosigner_workingExampleImage.png` |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
25 * Wrapper file: `biosigner_wrapper.R` |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
26 * R packages |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
27 + **batch** from CRAN |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
28 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
29 ```r |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
30 install.packages("batch", dep=TRUE) |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
31 ``` |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
32 + **biosigner** from Bioconductor |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
33 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
34 ```r |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
35 source("http://www.bioconductor.org/biocLite.R") |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
36 biocLite("biosigner") |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
37 ``` |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
38 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
39 ### Tests |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
40 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
41 The code in the wrapper can be tested by running the `runit/biosigner_runtests.R` R file |
0
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
42 |
2
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
43 You will need to install **RUnit** package in order to make it run: |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
44 ```r |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
45 install.packages('RUnit', dependencies = TRUE) |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
46 ``` |
0
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
47 |
2
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
48 ### Working example |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
49 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
50 See the **W4M00001a_sacurine-subset-statistics** or **W4M00003_diaplasma** shared histories in the **Shared Data/Published Histories** menu (https://galaxy.workflow4metabolomics.org/history/list_published) |
0
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
51 |
2
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
52 ### News |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
53 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
54 ###### CHANGES IN VERSION 2.2.6 |
0
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
55 |
2
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
56 INTERNAL MODIFICATION |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
57 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
58 * Minor internal modifications |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
59 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
60 ###### CHANGES IN VERSION 2.2.4 |
1
4ff502a46189
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit 8f8ca9d7be625518f878eae833c8d55eb64c7761
ethevenot
parents:
0
diff
changeset
|
61 |
2
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
62 INTERNAL MODIFICATION |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
63 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
64 * Internal updates for planemo and travis validation |
1
4ff502a46189
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit 8f8ca9d7be625518f878eae833c8d55eb64c7761
ethevenot
parents:
0
diff
changeset
|
65 |
2
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
66 ###### CHANGES IN VERSION 2.2.2 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
67 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
68 INTERNAL MODIFICATION |
0
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
69 |
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
70 * Internal updates to biosigner package versions of 1.0.0 and above, and ropls versions of 1.4.0 and above (i.e. using S4 methods instead of S3) |
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
71 |
2
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
72 ###### CHANGES IN VERSION 2.2.1 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
73 |
b2414be87d4b
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit d85321a93588817e9e8884b90dde6331292bbe79
ethevenot
parents:
1
diff
changeset
|
74 NEW FEATURE |
0
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
75 |
48e4be935243
planemo upload for repository https://github.com/workflow4metabolomics/biosigner.git commit b8af709c9fd6ed283fc4e4249dcf692556927b2d
ethevenot
parents:
diff
changeset
|
76 * Creation of the tool: with S3 versions of biosigner (< 1.0.0) and ropls (< 1.4.0) |