diff README.rst @ 12:15646e937936 draft

planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
author lecorguille
date Fri, 07 Apr 2017 07:35:01 -0400
parents 91311aa08cdc
children c934dd5c49a9
line wrap: on
line diff
--- a/README.rst	Mon Jan 30 08:52:59 2017 -0500
+++ b/README.rst	Fri Apr 07 07:35:01 2017 -0400
@@ -1,7 +1,33 @@
+Job Dynamic Destination Mapping
+-------------------------------
+
+**Why**
+
+xcmsSet wrapper allow both individual file and zip file which can contain several samples.
+Thus, it can be interesting to adjust the number of thread according to the input type.
+For example: 1 thread for a single mzXML or NetCDF file and 8 threads for a zip file.
+
+**What**
+
+The [Dynamic Destination Mapping](https://galaxyproject.org/admin/config/jobs/#dynamic-destination-mapping) allow Galaxy to choose a destination at runtime based on factors such as the job inputs, user submitting the job, cluster status, etc...
+
+**How**
+
+ - The file `destinations_input_type.py` (shiped with this tool) must be place in `lib/galaxy/jobs/rules/`
+ - The `job_conf.xml` must be inspired by the `job_conf.xml.sample` shiped with this tool
+ - The final destination names must match between the `job_conf.xml` and the `destinations_input_type.py`
+ - Restart Galaxy
+
 
 Changelog/News
 --------------
 
+**Version 2.1.0 - 22/02/2017**
+
+- NEW: The W4M tools will be able now to take as input a single file. It will allow to submit in parallel several files and merge them afterward using "xcms.xcmsSet Merger" before "xcms.group".
+
+- BUGFIX: the default value of "matchedFilter" -> "Step size to use for profile generation" which was of 0.01 have been changed to fix with the XMCS default values to 0.1
+
 **Version 2.0.11 - 22/12/2016**
 
 - BUGFIX: propose scanrange for all methods
@@ -49,13 +75,3 @@
 - IMPROVEMENT: new datatype/dataset formats (rdata.xcms.raw, rdata.xcms.group, rdata.xcms.retcor ...) will facilitate the sequence of tools and so avoid incompatibility errors.
 
 - IMPROVEMENT: parameter labels have changed to facilitate their reading.
-
-
-Test Status
------------
-
-Planemo test using conda: passed
-
-Planemo test using source env.sh: passed
-
-Planemo shed_test : passed