Mercurial > repos > lecorguille > xcms_xcmsset

annotate README.rst @ 44:ceff49826bf2 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 a5136bfc124956893f4f0c91808d1c0d78c4ea01
author lecorguille
date Mon, 29 Apr 2019 06:08:03 -0400
parents a8f0dd2aff5a
children 6f9224f32a34
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
29
5dba1c94fb94 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit bff1445c9b00ccdbe05ee3dc6ed24221033384b9
lecorguille
parents: 26
diff changeset
16 1. The file [`destinations_input_type.py`](https://raw.githubusercontent.com/workflow4metabolomics/xcms/master/galaxy/xcms_xcmsset/destinations_input_type.py) (shiped with this tool) must be place in `lib/galaxy/jobs/rules/`
5dba1c94fb94 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit bff1445c9b00ccdbe05ee3dc6ed24221033384b9
lecorguille
parents: 26
diff changeset
17 2. The `job_conf.xml` must be inspired by the [`job_conf.xml.sample`](https://github.com/workflow4metabolomics/xcms/blob/master/galaxy/xcms_xcmsset/job_conf.xml.sample) shiped with this tool
5dba1c94fb94 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit bff1445c9b00ccdbe05ee3dc6ed24221033384b9
lecorguille
parents: 26
diff changeset
18 3. The final destination names must match between the `job_conf.xml` and the `destinations_input_type.py`
5dba1c94fb94 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit bff1445c9b00ccdbe05ee3dc6ed24221033384b9
lecorguille
parents: 26
diff changeset
19 4. Restart Galaxy
26
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
44
ceff49826bf2 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a5136bfc124956893f4f0c91808d1c0d78c4ea01
lecorguille
parents: 43
diff changeset
25 .. _News: https://bioconductor.org/packages/release/bioc/news/xcms/NEWS
43
a8f0dd2aff5a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f0d42bca2f34c58c04b55e5990058d479c0ae639
lecorguille
parents: 34
diff changeset
26
44
ceff49826bf2 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a5136bfc124956893f4f0c91808d1c0d78c4ea01
lecorguille
parents: 43
diff changeset
27 **Version 3.4.4.0 - 08/02/2019**
ceff49826bf2 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a5136bfc124956893f4f0c91808d1c0d78c4ea01
lecorguille
parents: 43
diff changeset
28
ceff49826bf2 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a5136bfc124956893f4f0c91808d1c0d78c4ea01
lecorguille
parents: 43
diff changeset
29 - UPGRADE: upgrade the xcms version from 3.0.0 to 3.4.4 (see XCMS News_)
43
a8f0dd2aff5a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f0d42bca2f34c58c04b55e5990058d479c0ae639
lecorguille
parents: 34
diff changeset
30
34
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
31 **Version 3.0.0.0 - 08/03/2018**
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
32
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
33 - UPGRADE: upgrade the xcms version from 1.46.0 to 3.0.0. So refactoring of a lot of underlying codes and methods. Some parameters may have been renamed.
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
34
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
35 - NEW: a bunch of new options: Spectra Filters (previously scanrange), CentWave.(mzCenterFun, fitgauss, verboseColumns), MatchedFilter.(sigma, impute, baseValue, max), MSW.(verboseColumns), ...
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
36
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
37 - UPDATE: since xcms 3.0.0, some options are no more available: scanrange (replace by filters), profmethod, MatchedFilter.step, MatchedFilter.sigma, MSW.winSize.noise, MSW.SNR.method
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
38
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
39 - IMPROVEMENT: the advanced options are now in sections. It will allow you to access to all the parameters and to know their default values.
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
40
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
41 - IMPROVEMENT: the tool "should" be now more flexible in term of file naming: it "should" accept space and comma. But don't be too imaginative :)
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
42
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
43 - CHANGE: removing of the TIC and BPC plots. You can new use the dedicated tool "xcms plot chromatogram"
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
44
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
45
31
e93153c07be0 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents: 29
diff changeset
46 **Version 2.1.1 - 29/11/2017**
29
5dba1c94fb94 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit bff1445c9b00ccdbe05ee3dc6ed24221033384b9
lecorguille
parents: 26
diff changeset
47
31
e93153c07be0 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents: 29
diff changeset
48 - BUGFIX: To avoid issues with accented letter in the parentFile tag of the mzXML files, we changed a hidden mechanim to LC_ALL=C
29
5dba1c94fb94 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit bff1445c9b00ccdbe05ee3dc6ed24221033384b9
lecorguille
parents: 26
diff changeset
49
34
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
50
26
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
51 **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
52
602acc32b549 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 22c4e92909198328fc7439ff47e4546a273eb907
lecorguille
parents: 16
diff changeset
53 - 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
54
26
626d3db664ef planemo upload for repository https://github.com/workflow4metabolomics/xcms commit b1ebca6e0188e0aa0645e67259d6729ce80a6bdf
lecorguille
parents: 20
diff changeset
55 - 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
56
34
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
57
16
f28041d2180a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents: 15
diff changeset
58 **Version 2.0.11 - 22/12/2016**
f28041d2180a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents: 15
diff changeset
59
f28041d2180a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents: 15
diff changeset
60 - BUGFIX: propose scanrange for all methods
f28041d2180a planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents: 15
diff changeset
61
34
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
62
15
1a9bbd4670e8 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents: 13
diff changeset
63 **Version 2.0.10 - 22/12/2016**
1a9bbd4670e8 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents: 13
diff changeset
64
1a9bbd4670e8 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 92dd69e5b063aad05a9b2b75e21c78bfa46c4b94
lecorguille
parents: 13
diff changeset
65 - 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
66
34
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
67
13
68547432079b planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents: 9
diff changeset
68 **Version 2.0.9 - 06/07/2016**
68547432079b planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents: 9
diff changeset
69
34
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
70 - UPGRADE: upgrade the xcms version from 1.44.0 to 1.46.0
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
71
13
68547432079b planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents: 9
diff changeset
72
6
60f6c208ca16 planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents: 5
diff changeset
73 **Version 2.0.8 - 06/04/2016**
60f6c208ca16 planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents: 5
diff changeset
74
60f6c208ca16 planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents: 5
diff changeset
75 - TEST: refactoring to pass planemo test using conda dependencies
60f6c208ca16 planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents: 5
diff changeset
76
4
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
77
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
78 **Version 2.0.7 - 10/02/2016**
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
79
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
80 - BUGFIX: better management of errors. Datasets remained green although the process failed
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
81
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
82 - 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
83
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
84 - 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
85
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
86 - UPDATE: refactoring of internal management of inputs/outputs
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
87
34
efd23113d5f4 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 49203f8a5271fa5e6bb889e907df71ebf7757309
lecorguille
parents: 31
diff changeset
88 - TEST: refactoring to feed the new report tool
4
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
89
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
90
5
b9a87af62223 planemo upload commit 5a5b747865d7fb76f711bce2d9ce2a0f82a2a374-dirty
lecorguille
parents: 4
diff changeset
91 **Version 2.0.2 - 18/01/2016**
4
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
92
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
93 - 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
94
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
95
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
96 **Version 2.0.2 - 09/10/2015**
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
97
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
98 - 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
99
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
100
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
101 **Version 2.0.2 - 02/06/2015**
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
102
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
103 - 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
104
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
105 - 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
106
4509e9dd03e4 planemo upload
lecorguille
parents:
diff changeset
107 - IMPROVEMENT: parameter labels have changed to facilitate their reading.