Mercurial > repos > lecorguille > xcms_xcmsset

annotate README.rst @ 26:626d3db664ef draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
author lecorguille
date Wed, 22 Mar 2017 16:04:45 -0400
parents d7971ea3ad1d
children 5dba1c94fb94
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
1 Job Dynamic Destination Mapping
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
2 -------------------------------
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
3
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
4 **Why**
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
5
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
6 xcmsSet wrapper allow both individual file and zip file which can contain several samples.
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
7 Thus, it can be interesting to adjust the number of thread according to the input type.
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
8 For example: 1 thread for a single mzXML or NetCDF file and 8 threads for a zip file.
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
9
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
10 **What**
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
11
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
12 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...
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
13
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
14 **How**
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
15
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
16 - The file `destinations_input_type.py` (shiped with this tool) must be place in `lib/galaxy/jobs/rules/`
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
17 - The `job_conf.xml` must be inspired by the `job_conf.xml.sample` shiped with this tool
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
18 - The final destination names must match between the `job_conf.xml` and the `destinations_input_type.py`
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
19 - Restart Galaxy
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
20
4
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
21
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
22 Changelog/News
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
23 --------------
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
24
26
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
25 **Version 2.1.0 - 22/02/2017**
17
602acc32b549 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 22c4e92909198328fc7439ff47e4546a273eb907
lecorguille
parents: 16
diff changeset
26
602acc32b549 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 22c4e92909198328fc7439ff47e4546a273eb907
lecorguille
parents: 16
diff changeset
27 - 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".
602acc32b549 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 22c4e92909198328fc7439ff47e4546a273eb907
lecorguille
parents: 16
diff changeset
28
26
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
29 - 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
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
30
16
f28041d2180a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents: 15
diff changeset
31 **Version 2.0.11 - 22/12/2016**
f28041d2180a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents: 15
diff changeset
32
f28041d2180a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents: 15
diff changeset
33 - BUGFIX: propose scanrange for all methods
f28041d2180a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents: 15
diff changeset
34
15
1a9bbd4670e8 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents: 13
diff changeset
35 **Version 2.0.10 - 22/12/2016**
1a9bbd4670e8 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents: 13
diff changeset
36
1a9bbd4670e8 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents: 13
diff changeset
37 - BUGFIX: when having only one group (i.e. one folder of raw data) the BPC and TIC pdf files do not contain any graph
1a9bbd4670e8 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents: 13
diff changeset
38
13
68547432079b planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents: 9
diff changeset
39 **Version 2.0.9 - 06/07/2016**
68547432079b planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents: 9
diff changeset
40
68547432079b planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents: 9
diff changeset
41 - UPGRADE: upgrate the xcms version from 1.44.0 to 1.46.0
68547432079b planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents: 9
diff changeset
42
6
60f6c208ca16 planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents: 5
diff changeset
43 **Version 2.0.8 - 06/04/2016**
60f6c208ca16 planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents: 5
diff changeset
44
60f6c208ca16 planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents: 5
diff changeset
45 - TEST: refactoring to pass planemo test using conda dependencies
60f6c208ca16 planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents: 5
diff changeset
46
4
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
47
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
48 **Version 2.0.7 - 10/02/2016**
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
49
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
50 - BUGFIX: better management of errors. Datasets remained green although the process failed
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
51
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
52 - BUGFIX/IMPROVEMENT: New checking steps around the imported data in order to raise explicte error message before or after launch XCMS: checking of bad characters in the filenames, checking of the XML integrity and checking of duplicates which can appear in the sample names during the XCMS process because of bad characters
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
53
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
54 - BUGFIX/IMPROVEMENT: New step to check and delete bad characters in the XML: accented characters in the storage path of the mass spectrometer
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
55
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
56 - UPDATE: refactoring of internal management of inputs/outputs
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
57
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
58 - UPDATE: refactoring to feed the new report tool
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
59
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
60
5
b9a87af62223 planemo upload commit 5a5b747865d7fb76f711bce2d9ce2a0f82a2a374-dirty
lecorguille
parents: 4
diff changeset
61 **Version 2.0.2 - 18/01/2016**
4
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
62
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
63 - BUGFIX: Some zip files were tag as "corrupt" by R. We have changed the extraction mode to deal with thoses cases.
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
64
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
65
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
66 **Version 2.0.2 - 09/10/2015**
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
67
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
68 - BUGFIX: Some users reported a bug in xcms.xcmsSet. The preprocessing stops itself and doesn't import the whole dataset contained in the zip file without warning. But meanwhile, please check your samplemetadata dataset and the number of rows.
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
69
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
70
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
71 **Version 2.0.2 - 02/06/2015**
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
72
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
73 - NEW: The W4M workflows will now take as input a zip file to ease the transfer and to improve dataset exchange between tools and users. (See How_to_upload). The previous "Library directory name" is still available but we invite user to switch on the new zip system as soon as possible.
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
74
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
75 - 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.
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
76
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
77 - IMPROVEMENT: parameter labels have changed to facilitate their reading.