annotate README.rst @ 24:999f9db0ca2c draft

"planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f1caf2a3bf23cf319a75dd12c86402555dd02617"
author workflow4metabolomics
date Wed, 12 Feb 2020 08:28:33 -0500
parents fbcf5f621aa7
children 26d77e9ceb49
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
1
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
2 Changelog/News
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
3 --------------
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
4
19
fbcf5f621aa7 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit d481a27556155e3587901d702d364b71f28e30b9
lecorguille
parents: 18
diff changeset
5 .. _News: https://bioconductor.org/packages/release/bioc/news/xcms/NEWS
18
27fbe73c4279 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f0d42bca2f34c58c04b55e5990058d479c0ae639
lecorguille
parents: 17
diff changeset
6
24
999f9db0ca2c "planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f1caf2a3bf23cf319a75dd12c86402555dd02617"
workflow4metabolomics
parents: 19
diff changeset
7 **Version 3.6.1.0 - 03/09/2019**
999f9db0ca2c "planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f1caf2a3bf23cf319a75dd12c86402555dd02617"
workflow4metabolomics
parents: 19
diff changeset
8
999f9db0ca2c "planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f1caf2a3bf23cf319a75dd12c86402555dd02617"
workflow4metabolomics
parents: 19
diff changeset
9 - UPGRADE: upgrade the xcms version from 3.4.4 to 3.6.1 (see XCMS News_)
999f9db0ca2c "planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f1caf2a3bf23cf319a75dd12c86402555dd02617"
workflow4metabolomics
parents: 19
diff changeset
10
19
fbcf5f621aa7 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit d481a27556155e3587901d702d364b71f28e30b9
lecorguille
parents: 18
diff changeset
11 **Version 3.4.4.0 - 08/02/2019**
fbcf5f621aa7 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit d481a27556155e3587901d702d364b71f28e30b9
lecorguille
parents: 18
diff changeset
12
fbcf5f621aa7 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit d481a27556155e3587901d702d364b71f28e30b9
lecorguille
parents: 18
diff changeset
13 - UPGRADE: upgrade the xcms version from 3.0.0 to 3.4.4 (see XCMS News_)
18
27fbe73c4279 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f0d42bca2f34c58c04b55e5990058d479c0ae639
lecorguille
parents: 17
diff changeset
14
27fbe73c4279 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f0d42bca2f34c58c04b55e5990058d479c0ae639
lecorguille
parents: 17
diff changeset
15 - BUGFIX: issue with Inf values in the exported DataMatrix: https://github.com/sneumann/xcms/issues/323#issuecomment-433044378
27fbe73c4279 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f0d42bca2f34c58c04b55e5990058d479c0ae639
lecorguille
parents: 17
diff changeset
16
17
b6b62413936f planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 37b0a6a7686f701e4bf00db97ae2c1b82cd6e989
lecorguille
parents: 16
diff changeset
17 **Version 3.0.0.2 - 09/11/2018**
b6b62413936f planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 37b0a6a7686f701e4bf00db97ae2c1b82cd6e989
lecorguille
parents: 16
diff changeset
18
b6b62413936f planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 37b0a6a7686f701e4bf00db97ae2c1b82cd6e989
lecorguille
parents: 16
diff changeset
19 - BUGFIX: issue when the vector at peakidx is too long and is written in a new line during the export of the peaklist
b6b62413936f planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 37b0a6a7686f701e4bf00db97ae2c1b82cd6e989
lecorguille
parents: 16
diff changeset
20
b6b62413936f planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 37b0a6a7686f701e4bf00db97ae2c1b82cd6e989
lecorguille
parents: 16
diff changeset
21
16
34fe699200ce planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 878be1bfbe93af0a140df76fa47f0a82a48189e3
lecorguille
parents: 13
diff changeset
22 **Version 3.0.0.1 - 09/10/2018**
34fe699200ce planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 878be1bfbe93af0a140df76fa47f0a82a48189e3
lecorguille
parents: 13
diff changeset
23
34fe699200ce planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 878be1bfbe93af0a140df76fa47f0a82a48189e3
lecorguille
parents: 13
diff changeset
24 - IMPROVEMENT: the export of the PeakList is now mandatory
34fe699200ce planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 878be1bfbe93af0a140df76fa47f0a82a48189e3
lecorguille
parents: 13
diff changeset
25
34fe699200ce planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 878be1bfbe93af0a140df76fa47f0a82a48189e3
lecorguille
parents: 13
diff changeset
26
13
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
27 **Version 3.0.0.0 - 08/03/2018**
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
28
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
29 - 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.
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
30
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
31 - UPDATE: since xcms 3.0.0, the selection of a method is no more needed (chrom or MSW). xcms will detect from the data the peak picking method used in findChromPeaks
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
32
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
33 - UPDATE: since xcms 3.0.0, new parameters are available: expandMz, expandRt and ppm
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
34
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
35
12
dcb9041cb9ea planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 4897a06ef248e2e74e57a496dd68adbda3c828f1
lecorguille
parents: 11
diff changeset
36 **Version 2.1.1 - 29/11/2017**
dcb9041cb9ea planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 4897a06ef248e2e74e57a496dd68adbda3c828f1
lecorguille
parents: 11
diff changeset
37
dcb9041cb9ea planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 4897a06ef248e2e74e57a496dd68adbda3c828f1
lecorguille
parents: 11
diff changeset
38 - BUGFIX: To avoid issues with accented letter in the parentFile tag of the mzXML files, we changed a hidden mechanim to LC_ALL=C
dcb9041cb9ea planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 4897a06ef248e2e74e57a496dd68adbda3c828f1
lecorguille
parents: 11
diff changeset
39
13
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
40
11
de0d85537ee3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents: 9
diff changeset
41 **Version 2.1.0 - 07/02/2017**
de0d85537ee3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents: 9
diff changeset
42
de0d85537ee3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents: 9
diff changeset
43 - IMPROVEMENT: change the management of the peaklist ids. The main ids remain the same as xcms generated. The export setiings now only add custom names in the variableMetadata tab (namecustom)
de0d85537ee3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents: 9
diff changeset
44
de0d85537ee3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents: 9
diff changeset
45 - IMPROVEMENT: xcms.fillpeaks can deal with merged individual data
de0d85537ee3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents: 9
diff changeset
46
13
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
47
9
ee29f0a6e361 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents: 8
diff changeset
48 **Version 2.0.8 - 22/12/2016**
ee29f0a6e361 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents: 8
diff changeset
49
13
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
50 - IMPROVEMENT: Add an option to export the peak list at this step without having to wait for CAMERA.annotate
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
51
9
ee29f0a6e361 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents: 8
diff changeset
52
8
cce30b3398e0 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents: 4
diff changeset
53 **Version 2.0.7 - 06/07/2016**
cce30b3398e0 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents: 4
diff changeset
54
cce30b3398e0 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents: 4
diff changeset
55 - UPGRADE: upgrate the xcms version from 1.44.0 to 1.46.0
cce30b3398e0 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents: 4
diff changeset
56
13
91c71f3808f3 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 12
diff changeset
57
4
2edfa5e1f719 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
58 **Version 2.0.6 - 04/04/2016**
2edfa5e1f719 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
59
2edfa5e1f719 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
60 - TEST: refactoring to pass planemo test using conda dependencies
2edfa5e1f719 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
61
2edfa5e1f719 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 83b80dcd96b379518c2e4ace992affc889d32ca6
lecorguille
parents: 3
diff changeset
62
3
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
63 **Version 2.0.5 - 10/02/2016**
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
64
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
65 - BUGFIX: better management of errors. Datasets remained green although the process failed
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
66
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
67 - UPDATE: refactoring of internal management of inputs/outputs
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
68
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
69 - UPDATE: refactoring to feed the new report tool
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
70
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
71
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
72 **Version 2.0.2 - 02/06/2015**
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
73
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
74 - 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.
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
75
5a54397dbc97 planemo upload
lecorguille
parents:
diff changeset
76 - IMPROVEMENT: parameter labels have changed to facilitate their reading.