Mercurial > repos > galaxyp > openms_peakpickerhires

annotate readme.md @ 9:decc397c3b7e draft

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 2adf8edc3de4e1cd3b299b26abb14544d17d0636"
author galaxyp
date Fri, 06 Nov 2020 20:31:34 +0000
parents 146b59d2d3e5
children 6b01678ec2fc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5ae104d0da6e 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
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
2 =========================
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
3
5ae104d0da6e 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.
5ae104d0da6e 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.
5ae104d0da6e 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.
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
7
5ae104d0da6e 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:
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
9
5ae104d0da6e 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
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
11 * https://www.openms.de/
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
12
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
13 The wrappers for these tools and most of their tests are automatically
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
14 generated using the `generate.sh` script. The generation of the tools is
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
15 based on the CTDConverter (https://github.com/WorkflowConversion/CTDConverter)
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
16 which can be fine tuned via the `hardcoded_params.json` file. This file allows
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
17 to blacklist and hardcode parameters and to modify or set arbitrary
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
18 CTD/XML attributes.
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
19
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
20 Note that, due to its size, the test data is excluded from this repository. In
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
21 order to generate the test data on call `test-data.sh`.
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
22
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
23 Manual updates should only be done to
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
24
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
25 - the `@GALAXY_VERSION@"` token in `macros.xml`
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
26 - and the manually contributed tests in `macros_test.xml` (The goal is that all
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
27 tools that do not have an automatically generated test are covered here)
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
28 - the `hardcoded_params.json` files
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
29
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
30 In a few cases patches may be acceptable.
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
31
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
32 Installation
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
33 ============
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
34
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
35 The Galaxy OpenMS tools can be installed from the toolshed. While most tools
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
36 will work out of the box some need attention since requirements can not be
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
37 fulfilled via Conda:
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
38
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
39 Not yet in Conda are:
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
40
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
41 - SpectraST (http://tools.proteomecenter.org/wiki/index.php?title=SpectraST)
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
42 - MaRaCluster (https://github.com/statisticalbiotechnology/maracluster)
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
43
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
44 Binaries for these tools can easily be obtained via:
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
45
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
46 ```
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
47 VERSION=....
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
48 git git clone -b release/$VERSION.0 https://github.com/OpenMS/OpenMS.git OpenMS$VERSION.0-git
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
49 git submodule init OpenMS$VERSION.0-git
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
50 git submodule update OpenMS$VERSION.0-git
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
51 ```
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
52
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
53 They are located in `OpenMS$VERSION-git/THIRDPARTY/`.
0
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
54
8
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
55 Not in Conda due to licencing restrictions:
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
56
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
57 - Mascot http://www.matrixscience.com/
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
58 - MSFragger https://github.com/Nesvilab/MSFragger
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
59 - Novor http://www.rapidnovor.org/novor
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
60
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
61 There are multiple ways to enable the Galaxy tools to use these binaries.
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
62
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
63 - Just copy them to the `bin` path within Galaxy's conda environment
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
64 - Put them in any other path that that is included in PATH
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
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.
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
66
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
67 Working
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
68 =======
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
69
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
70 The tools work by:
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
71
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
72 Preprocessing:
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
73
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
74 - For each input / output data set parameter a directory is crated (named by
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
75 the parameter)
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
76 - For input data set parameters the links to the actual location of the data
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
77 sets are created
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
78
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
79 Main:
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
80
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
81 - The galaxy wrapper create two json config files: one containing the
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
82 parameters and the values chosen by the user and the other the values of
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
83 hardcoded parameters.
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
84 - With `OpenMSTool -write_ctd ./` a CTD (names OpenMSTool.ctd) file is
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
85 generated that contains the default values.
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
86 - A call to `fill_ctd.py` fills in the values from the json config files into
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
87 the CTD file
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
88 - The actual tool is called `OpenMSTool -ini OpenMSTool.ctd` and also all input
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
89 and output parameters are given on the command line.
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
90
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
91 Postprocessing:
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
92
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
93 - output data sets are moved to the final locations
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
94
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
95 Note: The reason for handling data sets on the command line (and not specifying
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
96 them in the CTD file) is mainly that all files in Galaxy have the extension
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
97 `.dat` and OpenMS tools require an appropriate extension. But this may change
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
98 in the future.
0
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
99
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
100 Generating OpenMS wrappers
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
101 ==========================
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
102
8
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
103 1. remove old test data: `rm -rf $(ls -d test-data/* | egrep -v "random|\.loc")`
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
104 2. `./generate.sh`
0
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
105
8
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
106 Whats happening:
0
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
107
8
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
108 1. The binaries of the OpenMS package can generate a CTD file that describes
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
109 the parameters. These CTD files are converted to xml Galaxy tool descriptions
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
110 using the `CTDConverter`.
0
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
111
8
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
112 2. The CI testing framework of OpenMS contains command lines and test data
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
113 (https://github.com/OpenMS/OpenMS/tree/develop/src/tests/topp). These tests
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
114 are described in two CMake files.
0
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
115
8
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
116 - From these CMake files Galaxy tests are auto generated and stored in `macros_autotest.xml`
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
117 - The command lines are stored in `prepare_test_data.sh` for regeneration of test data
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
118
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
119 More details can be found in the comments of the shell script.
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
120
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
121 Open problems
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
122 =============
0
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
123
8
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
124 Some tools stall in CI testing using `--biocontainers` which is why the OpenMS
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
125 tools are currently listed in `.tt_biocontainer_skip`. This is
1
94b97d2d98a4 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 9a14ed1f2d3c9abdfb080251b3419dd9e0c52a14
galaxyp
parents: 0
diff changeset
126
8
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
127 - AssayGeneratorMetabo and SiriusAdapter (both depend on sirius)
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
128 - OMSSAAdapter
1
94b97d2d98a4 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 9a14ed1f2d3c9abdfb080251b3419dd9e0c52a14
galaxyp
parents: 0
diff changeset
129
8
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
130 Using `docker -t` seems to solve the problem (see
146b59d2d3e5 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit e499c9124d3fd85a7fc47b95c206ce91a5e3678c-dirty"
galaxyp
parents: 6
diff changeset
131 https://github.com/galaxyproject/galaxy/issues/10153).
0
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
132
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
133 Licence (MIT)
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
134 =============
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
135
5ae104d0da6e 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
5ae104d0da6e 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
5ae104d0da6e 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
5ae104d0da6e 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
5ae104d0da6e 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
5ae104d0da6e 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:
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
142
5ae104d0da6e 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
5ae104d0da6e 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.
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
145
5ae104d0da6e 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
5ae104d0da6e 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,
5ae104d0da6e 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
5ae104d0da6e 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
5ae104d0da6e 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,
5ae104d0da6e 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
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
152 THE SOFTWARE.
5ae104d0da6e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
153