annotate README.rst @ 16:fe4682eb938c

small improvement
author pieter.lukasse@wur.nl
date Mon, 23 Mar 2015 08:40:42 +0100
parents dffc38727496
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
1 PRIMS-metabolomics toolset & Galaxy wrappers
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
2 ============================================
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
3
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
4 Metabolomics module of Plant Research International's Mass Spectrometry (PRIMS) toolsuite.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
5 This toolset consists of custom tools to enable metabolite identifications and
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
6 Retention Index (RI) based Quality Control (RIQC) for Mass Spectrometry metabolomics data.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
7
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
8 Copyright:
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
9 * 2012: NIST_UTIL and RIQC tools: Copyright (c) 2012 Maarten Kooyman and Marcel Kempenaar, NBIC BRS
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
10 * 2013: all tools: Copyright (c) 2013 by Pieter Lukasse, Plant Research International (PRI),
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
11 Wageningen, The Netherlands. All rights reserved. See the license text below.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
12
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
13 Galaxy wrappers and installation are available from the Galaxy Tool Shed at:
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
14 http://toolshed.g2.bx.psu.edu/view/pieterlukasse/prims_metabolomics
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
15
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
16 History
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
17 =======
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
18
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
19 ============== ======================================================================
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
20 Date Changes
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
21 -------------- ----------------------------------------------------------------------
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
22 December 2014 * Added MsClust support for parsing XCMS alignment results.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
23 * Improved output reports for XCMS wrappers.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
24 November 2014 * Added XCMS related tool wrappers (for metaMS and diffreport)
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
25 September 2014 * Added new membership cutoff option for final clusters in MsClust
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
26 * Improved MsClust memory usage for large datasets
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
27 * Simplified MsClust HTML report
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
28 * Added option for microminutes based clustering instead of scannr
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
29 based in MsClust
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
30 April 2014 * Added interface to ExactMassDB, Pep1000, KEGG, KNApSAcK, Flavonoid
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
31 Viewer, LipidMAPS, HMDB, PubChem, by using the service MFSearcher.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
32 This enables users to query multiple public repositories for
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
33 elemental compositions from accurate mass values detected by
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
34 high-resolution mass spectrometers. NB: see also added
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
35 licensing info below.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
36 March 2014 * Added interface to METEXP data store, including tool to fire
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
37 queries in batch mode
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
38 * Improved quantification output files of MsClust, a.o. sorting
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
39 mass list based on intensity (last two columns of quantification
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
40 files)
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
41 January 2014 * first release via Tool Shed, combining the RIQC and MsClust in a
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
42 single package (this package)
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
43 * integration with METEXP software (data store for metabolomics
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
44 experiments with respective metadata and identifications)
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
45 2013 * hand-over of the NIST_UTIL and RIQC tools from the NBIC team to
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
46 Plant Research International
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
47 2012 * development of MsClust 2.0, making it also suitable for Galaxy
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
48 <2011 * development and publication of MsClust 1.0
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
49 ============== ======================================================================
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
50
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
51 Tool Versioning
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
52 ===============
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
53
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
54 PRIMS tools will have versions of the form X.Y.Z. Versions
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
55 differing only after the second decimal should be completely
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
56 compatible with each other. Breaking changes should result in an
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
57 increment of the number before and/or after the first decimal. All
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
58 tools of version less than 1.0.0 should be considered beta.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
59
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
60
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
61 Bug Reports & other questions
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
62 =============================
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
63
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
64 For the time being issues can be reported via the contact form at:
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
65 http://www.wageningenur.nl/en/Persons/PNJ-Pieter-Lukasse.htm
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
66
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
67 Developers, Contributions & Collaborations
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
68 ==========================================
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
69
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
70 If you wish to join forces and collaborate on some of the
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
71 tools do not hesitate to contact Pieter Lukasse via the contact form above.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
72
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
73
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
74 License (Apache, Version 2.0)
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
75 =============================
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
76
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
77 Copyright 2013 Pieter Lukasse, Plant Research International (PRI).
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
78
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
79 Licensed under the Apache License, Version 2.0 (the "License");
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
80 you may not use this software except in compliance with the License.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
81 You may obtain a copy of the License at
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
82
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
83 http://www.apache.org/licenses/LICENSE-2.0
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
84
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
85 Unless required by applicable law or agreed to in writing, software
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
86 distributed under the License is distributed on an "AS IS" BASIS,
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
87 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
88 See the License for the specific language governing permissions and
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
89 limitations under the License.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
90
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
91
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
92 License for third party services
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
93 ================================
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
94 MFSearcher service : http://webs2.kazusa.or.jp/mfsearcher/#090
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
95 In the MFSearcher system, the compound data provided by KEGG, Flavonoid Viewer, LIPID MAPS, HMDB and PubChem
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
96 were downloaded for academic purposes. The compound data of KNApSAcK is provided by Prof. Kanaya in
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
97 Nara Institute of Science and Technology (NAIST). The part of these data are utilized to construct the
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
98 specified databases for rapid mass searching in the MFSearcher system after re-calculating the molecular weights.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
99 Please preserve the contracts of each original databases when utilizing the search results against these
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
100 databases by MFSearcher.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
101
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
102 The searching system of MFSearcher, the ExactMassDB database, and the Pep1000 database by Kazusa DNA
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
103 Research Institute is licensed under a Creative Commons Attribution-NonCommercial 3.0 Unported License.