Mercurial > repos > galaxyp > openms_xfdr
annotate readme.md @ 8:87dda030bc92 draft
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
author | galaxyp |
---|---|
date | Thu, 01 Dec 2022 18:59:41 +0000 |
parents | 81402a5e4173 |
children | cf9b51c0b15e |
rev | line source |
---|---|
0
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
1 Galaxy wrapper for OpenMS |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
2 ========================= |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
3 |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
4 OpenMS is an open-source software C++ library for LC/MS data management and analyses. |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
5 It offers an infrastructure for the rapid development of mass spectrometry related software. |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
6 OpenMS is free software available under the three clause BSD license and runs under Windows, MacOSX and Linux. |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
7 |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
8 More informations are available at: |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
9 |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
10 * https://github.com/OpenMS/OpenMS |
4
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
11 * https://www.openms.de/ |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
12 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
13 The wrappers for these tools and most of their tests are automatically |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
14 generated using the `generate.sh` script. The generation of the tools is |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
15 based on the CTDConverter (https://github.com/WorkflowConversion/CTDConverter) |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
16 which can be fine tuned via the `hardcoded_params.json` file. This file allows |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
17 to blacklist and hardcode parameters and to modify or set arbitrary |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
18 CTD/XML attributes. |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
19 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
20 Note that, due to its size, the test data is excluded from this repository. In |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
21 order to generate the test data on call `test-data.sh`. |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
22 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
23 Manual updates should only be done to |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
24 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
25 - and the manually contributed tests in `macros_test.xml` (The goal is that all |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
26 tools that do not have an automatically generated test are covered here) |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
27 - the `hardcoded_params.json` files |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
28 |
8
87dda030bc92
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents:
4
diff
changeset
|
29 Wrapper versions are managed in `bump.json`. For tools listed in the file |
87dda030bc92
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents:
4
diff
changeset
|
30 the wrapper version will be set accordingly and otherwise `0` is used. |
87dda030bc92
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents:
4
diff
changeset
|
31 For a major update of the tool version the bump file should be reset (to `{}`). |
87dda030bc92
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents:
4
diff
changeset
|
32 |
4
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
33 In a few cases patches may be acceptable. |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
34 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
35 Installation |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
36 ============ |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
37 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
38 The Galaxy OpenMS tools can be installed from the toolshed. While most tools |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
39 will work out of the box some need attention since requirements can not be |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
40 fulfilled via Conda: |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
41 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
42 Not yet in Conda are: |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
43 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
44 - SpectraST (http://tools.proteomecenter.org/wiki/index.php?title=SpectraST) |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
45 - MaRaCluster (https://github.com/statisticalbiotechnology/maracluster) |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
46 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
47 Binaries for these tools can easily be obtained via: |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
48 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
49 ``` |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
50 VERSION=.... |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
51 git git clone -b release/$VERSION.0 https://github.com/OpenMS/OpenMS.git OpenMS$VERSION.0-git |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
52 git submodule init OpenMS$VERSION.0-git |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
53 git submodule update OpenMS$VERSION.0-git |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
54 ``` |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
55 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
56 They are located in `OpenMS$VERSION-git/THIRDPARTY/`. |
0
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
57 |
4
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
58 Not in Conda due to licencing restrictions: |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
59 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
60 - Mascot http://www.matrixscience.com/ |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
61 - MSFragger https://github.com/Nesvilab/MSFragger |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
62 - Novor http://www.rapidnovor.org/novor |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
63 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
64 There are multiple ways to enable the Galaxy tools to use these binaries. |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
65 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
66 - Just copy them to the `bin` path within Galaxy's conda environment |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
67 - Put them in any other path that that is included in PATH |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
68 - Edit the corresponding tools: In the command line part search for the parameters `-executable`, `-maracluster_executable`, or `-mascot_directory` and edit them appropriately. |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
69 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
70 Working |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
71 ======= |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
72 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
73 The tools work by: |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
74 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
75 Preprocessing: |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
76 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
77 - For input data set parameters the links to the actual location of the data |
8
87dda030bc92
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents:
4
diff
changeset
|
78 sets are created, the link names are `element_identifier`.`EXT`, where `EXT` |
87dda030bc92
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents:
4
diff
changeset
|
79 is an extension that is known by OpenMS |
87dda030bc92
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents:
4
diff
changeset
|
80 - In order to avoid name collisions for the created links each is placed in a |
87dda030bc92
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents:
4
diff
changeset
|
81 unique directory: `PARAM_NAME/DATASET_ID`, where `PARAM_NAME` is the name |
87dda030bc92
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents:
4
diff
changeset
|
82 of the parameter and `DATASET_ID` is the id of the Galaxy dataset |
87dda030bc92
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents:
4
diff
changeset
|
83 - the same happens for output parameters that are in 1:1 correspondence with |
87dda030bc92
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents:
4
diff
changeset
|
84 an input parameter |
87dda030bc92
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents:
4
diff
changeset
|
85 |
4
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
86 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
87 Main: |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
88 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
89 - The galaxy wrapper create two json config files: one containing the |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
90 parameters and the values chosen by the user and the other the values of |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
91 hardcoded parameters. |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
92 - With `OpenMSTool -write_ctd ./` a CTD (names OpenMSTool.ctd) file is |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
93 generated that contains the default values. |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
94 - A call to `fill_ctd.py` fills in the values from the json config files into |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
95 the CTD file |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
96 - The actual tool is called `OpenMSTool -ini OpenMSTool.ctd` and also all input |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
97 and output parameters are given on the command line. |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
98 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
99 Postprocessing: |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
100 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
101 - output data sets are moved to the final locations |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
102 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
103 Note: The reason for handling data sets on the command line (and not specifying |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
104 them in the CTD file) is mainly that all files in Galaxy have the extension |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
105 `.dat` and OpenMS tools require an appropriate extension. But this may change |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
106 in the future. |
0
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
107 |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
108 Generating OpenMS wrappers |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
109 ========================== |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
110 |
4
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
111 1. remove old test data: `rm -rf $(ls -d test-data/* | egrep -v "random|\.loc")` |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
112 2. `./generate.sh` |
0
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
113 |
4
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
114 Whats happening: |
0
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
115 |
4
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
116 1. The binaries of the OpenMS package can generate a CTD file that describes |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
117 the parameters. These CTD files are converted to xml Galaxy tool descriptions |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
118 using the `CTDConverter`. |
0
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
119 |
4
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
120 2. The CI testing framework of OpenMS contains command lines and test data |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
121 (https://github.com/OpenMS/OpenMS/tree/develop/src/tests/topp). These tests |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
122 are described in two CMake files. |
0
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
123 |
4
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
124 - From these CMake files Galaxy tests are auto generated and stored in `macros_autotest.xml` |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
125 - The command lines are stored in `prepare_test_data.sh` for regeneration of test data |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
126 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
127 More details can be found in the comments of the shell script. |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
128 |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
129 Open problems |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
130 ============= |
0
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
131 |
4
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
132 Some tools stall in CI testing using `--biocontainers` which is why the OpenMS |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
133 tools are currently listed in `.tt_biocontainer_skip`. This is |
0
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
134 |
4
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
135 - AssayGeneratorMetabo and SiriusAdapter (both depend on sirius) |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
136 - OMSSAAdapter |
0
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
137 |
4
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
138 Using `docker -t` seems to solve the problem (see |
81402a5e4173
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit ddf41e8bda1ba065f5cdec98e93dee8165ffc1b9"
galaxyp
parents:
1
diff
changeset
|
139 https://github.com/galaxyproject/galaxy/issues/10153). |
0
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
140 |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
141 Licence (MIT) |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
142 ============= |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
143 |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
144 Permission is hereby granted, free of charge, to any person obtaining a copy |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
145 of this software and associated documentation files (the "Software"), to deal |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
146 in the Software without restriction, including without limitation the rights |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
147 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
148 copies of the Software, and to permit persons to whom the Software is |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
149 furnished to do so, subject to the following conditions: |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
150 |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
151 The above copyright notice and this permission notice shall be included in |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
152 all copies or substantial portions of the Software. |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
153 |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
154 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
155 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
156 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
157 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
158 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
159 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
160 THE SOFTWARE. |
b19847e8f0a1
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents:
diff
changeset
|
161 |