Mercurial > repos > galaxyp > openms_psmfeatureextractor

annotate readme.md @ 6:2f0283c44ba4 draft default tip

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