Mercurial > repos > ethevenot > heatmap

annotate README.md @ 0:81ffd91ba495 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
author ethevenot
date Tue, 24 Oct 2017 09:32:23 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
1 Heatmap of the data matrix
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
2 ==========================
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
3
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
4 A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) infrastructure
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
5
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
6 Status: [![Build Status](https://travis-ci.org/workflow4metabolomics/heatmap.svg?branch=master)](https://travis-ci.org/workflow4metabolomics/heatmap).
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
7
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
8 ### Description
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
9
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
10 **Version:** 2.2.2
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
11 **Date:** 2016-08-04
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
12 **Author:** Etienne A. Thevenot (CEA, LIST, MetaboHUB, W4M Core Development Team)
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
13 **Email:** [etienne.thevenot(at)cea.fr](mailto:etienne.thevenot@cea.fr)
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
14 **Citation:** Thevenot E.A., Roux A., Xu Y., Ezan E. and Junot C. (2015). Analysis of the human adult urinary metabolome variations with age, body mass index and gender by implementing a comprehensive workflow for univariate and OPLS statistical analyses. *Journal of Proteome Research*, **14**:3322-3335. [doi:10.1021/acs.jproteome.5b00354](http://dx.doi.org/10.1021/acs.jproteome.5b00354)
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
15 **Licence:** CeCILL
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
16 **Reference history:** [W4M00001a_sacurine-subset-statistics](http://galaxy.workflow4metabolomics.org/history/list_published)
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
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)
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
18
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
19 ### Installation
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
20
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
21 * Configuration file: `heatmap_config.xml`
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
22 * Image files:
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
23 + `static/images/heatmap_workflowPositionImage.png`
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
24 + `static/images/heatmap_workingExampleImage.png`
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
25 * Wrapper file: `heatmap_wrapper.R`
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
26 * R packages
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
27 + **batch** from CRAN
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
28
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
29 ```r
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
30 install.packages("batch", dep=TRUE)
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
31 ```
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
32
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
33 ### Tests
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
34
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
35 The code in the wrapper can be tested by running the `runit/heatmap_runtests.R` R file
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
36
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
37 ### Working example
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
38
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
39 See the **W4M00001a_sacurine-subset-statistics** shared history in the **Shared Data/Published Histories** menu (https://galaxy.workflow4metabolomics.org/history/list_published)
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
40
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
41 ### News
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
42
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
43 ##### CHANGES IN VERSION 2.2.2
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
44
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
45 INTERNAL MODIFICATION
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
46
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
47 * Minor internal modifications
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
48
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
49 ##### CHANGES IN VERSION 2.2.0
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
50
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
51 NEW FEATURES
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
52
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
53 * Default method for the correlation coefficient is now 'pearson', instead of 'spearman' previously (the latter can still be selected in the advanced parameters)
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
54
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
55 * The 1-abs(correlation) dissimilarity is now available (in addition to the default '1-correlation') in case the sign of correlations between samples and between variables does not matter, as well as the euclidean, maximum, manhattan, canberra, binary, and minkowski dissimilarities
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
56
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
57 * A new red-green color scale is available
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
58
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
59 ##### CHANGES IN VERSION 2.1.2
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
60
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
61 INTERNAL MODIFICATION
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
62
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
63 * Creating additional files for planemo and travis validation
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
64
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
65 ##### CHANGES IN VERSION 2.0.2
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
66
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
67 INTERNAL MODIFICATION
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
68
81ffd91ba495 planemo upload for repository https://github.com/workflow4metabolomics/heatmap.git commit bbfc13f2e4fa9e7e5b562c96d0e570318d3482d9
ethevenot
parents:
diff changeset
69 * Creating tests for R code