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