https://sourceforge.net/p/fingerid/wiki/FingerID/Recent changes to FingerIDenMon, 13 Aug 2012 08:24:35 -0000https://sourceforge.net/p/fingerid/wiki/FingerID/<pre>--- v18 +++ v19 @@ -49,7 +49,7 @@ ------------------------- -We maintain two type of package. If you do not have OpenBabel-2.3.0 and LibSVM and not willing to install them, you can download our CDE package. Otherwise, you can download a much smaller standard package which you have to provide the OpenBabel path and LibSVM path as arguments. The related paper [Metabolites identification and fingerprint prediction via machine learning](http://bioinformatics.oxfordjournals.org/content/early/2012/07/18/bioinformatics.bts437.abstract) has more detail about the methods. +We maintain two type of package. If you do not have `OpenBabel-2.3.0` and `LibSVM` and not willing to install them, you can download our CDE package. Otherwise, you can download a much smaller standard package which you have to provide the `OpenBabel` path and `LibSVM` path as arguments. The related paper [Metabolites identification and fingerprint prediction via machine learning](http://bioinformatics.oxfordjournals.org/content/early/2012/07/18/bioinformatics.bts437.abstract) has more detail about the methods. To unzip the packages, you can use following scipt: @@ -64,31 +64,31 @@ To run the programme, follow the instructions below. 1. After unzipping the package, go to the `./cde-root/home/fs/hzshen/mass_classification/package/` folder. -+ Putting your training mass spectra and testing spectra into the train_data and test_data folders. The file should be in the MassBank format. We have sample training data and testing data in the folder. -+ Setting the arguments in fingerid.cfg Default values are there for all parameters. By using CDE, users do not need to provide libSVM path and OpenBabel path. -+ Run the program as ./fingerid-run -+ Search result are written in search.res. If validate is set to True in the main module, a file validate.res will also be there. Validate.res contains 3 rows: First row records the ranks of the correct molecules; Second row records search time for querying molecular database; Third row records the number of candidates after mass filtering. ++ Putting your training mass spectra and testing spectra into the `train_data` and `test_data` folders. The file should be in the MassBank format. We have sample training data and testing data in the folder. ++ Setting the arguments in `fingerid.cfg`. Default values are there for all parameters. By using CDE, users do not need to provide libSVM path and OpenBabel path. ++ Run the program as `./fingerid-run` ++ Search result are written in `search.res`. If validate is set to True in the main module, a file `validate.res` will also be there. `Validate.res` contains 3 rows: First row records the ranks of the correct molecules; Second row records search time for querying molecular database; Third row records the number of candidates after mass filtering. **Standard package usage instruction** The latest version of standard package is at here: [FingerID-1.2.tar.gz](http://sourceforge.net/projects/fingerid/files/FingerID-1.2.tar.gz/download) -To run the programme, you need to install OpenBabel-2.3.0 and LibSVM and then follow the instructions below. If you do not have OpenBabel-2.3.0 and LibSVM, you can download CDE fingerid package. +To run the programme, you need to install `OpenBabel-2.3.0` and `LibSVM` and then follow the instructions below. If you do not have `OpenBabel-2.3.0` and `LibSVM`, you can download CDE fingerid package. -1. Putting your training mass spectra and testing spectra into the train_data and test_data folders. The file should be in the MassBank format. We have sample training data and testing data in the folders. -+ Setting the arguments in fingerid.cfg. You have to provide OpenBabel-2.3.0 and LibSVM path. -+ Run the program as ./fingerid-run -+ Search results are written in search.res. If validate parameter in the main.py is set to True in the main module, a file validate.res will also be there. Validate.res contains 3 rows: First row records the ranks of the correct molecules; Second row records search time for querying molecular database; Third row records the number of candidates after mass filtering. +1. Putting your training mass spectra and testing spectra into the `train_data` and `test_data` folders. The file should be in the MassBank format. We have sample training data and testing data in the folders. ++ Setting the arguments in `fingerid.cfg`. You have to provide `OpenBabel-2.3.0` and `LibSVM` path. ++ Run the program as `./fingerid-run` ++ Search results are written in `search.res`. If validate parameter in the `main.py` is set to True in the main module, a file `validate.res` will also be there. `Validate.res` contains 3 rows: First row records the ranks of the correct molecules; Second row records search time for querying molecular database; Third row records the number of candidates after mass filtering. -The validate.res will contain useful information only if there are database IDs for the test data and you are searching the same database. For example, we have kegg ligand compound ID in the sample test data and we are searching kegg ligand database by default. +The `validate.res` will contain useful information only if there are database IDs for the test data and you are searching the same database. For example, we have kegg ligand compound ID in the sample test data and we are searching kegg ligand database by default. -Detailed description of avaliable arguments can be found in the main.py in the package. The kernel computation and SVM training may cost hours depending on the data size. +Detailed description of available arguments can be found in the `main.py` in the package. The kernel computation and SVM training may cost hours depending on the data size. **Database extension** -Users can extend the molecular database to any database, e.g. PubChem, if parse the data to specified format as in kegg_mass and kegg_fp.dict. But now we only support validation of the search on Kegg or PubChem (SEARCH_KEGG and SEARCH_PUBCHEM parameters in fingerid.cfg) +Users can extend the molecular database to any database, e.g. PubChem, if parse the data to specified format as in `kegg_mass` and `kegg_fp.dict`. But now we only support validation of the search on Kegg or PubChem (`SEARCH_KEGG` and `SEARCH_PUBCHEM` parameters in `fingerid.cfg`) -kegg_mass contains n*2 matrice where n is the number of entry for some molecular database and the first row is the id for the database entry and the second row is the exact mass of that entry. +`kegg_mass` contains `n*2` matrix where `n` is the number of entry for some molecular database and the first row is the id for the database entry and the second row is the exact mass of that entry. Example: C00001 18.0106 @@ -99,14 +99,19 @@ C00006 744.0833 ... ... -Kegg_fp.dict is the python dict ( {"C00001":"0100110101010101010100....","C00002":"11010111000010101010...",...} ) taking database id as the key and corresponding fingperprints as the value. It's a binary file and can be loaded into memory, for instance, by pickle module. You can creat your own dict by the following python code: +`Kegg_fp.dict` is the python + + :::python + dict( {"C00001":"0100110101010101010100....","C00002":"11010111000010101010...",...} ) + +taking database id as the key and corresponding fingperprints as the value. It's a binary file and can be loaded into memory, for instance, by `pickle` module. You can create your own dict by the following python code: :::python f = open("kegg_fp.dict","wb") pickle.write(f) f.close() -Notice that the kegg_fp.dict with this relase contains the fingerprints generated by OpenBabel-2.3.0 so to performe identification with this database, you have to use the same version of OpenBabel, that is 2.3.0. The fingerprints may be different in different version. If you are using another version of OpenBabel, you have to rebuild the kegg_fp.dict using your version of OpenBabel. +Notice that the `kegg_fp.dict` with this release contains the fingerprints generated by `OpenBabel-2.3.0` so to perform identification with this database, you have to use the same version of OpenBabel, that is 2.3.0. The fingerprints may be different in different version. If you are using another version of OpenBabel, you have to rebuild the `kegg_fp.dict` using your version of OpenBabel. -When you creat your own fingerprints dict, please use the FP2, FP3 and MACCS fingerprints (all together 528 fingerprints) in OpenBabel to make the fingerprints in dict and in the prediction comparable. +When you create your own fingerprints dict, please use the FP2, FP3 and MACCS fingerprints (all together 528 fingerprints) in OpenBabel to make the fingerprints in dict and in the prediction comparable. </pre>Markus HeinonenMon, 13 Aug 2012 08:24:35 -0000https://sourceforge.net8b332119a445aa7c258ce3632d3ecf1b3d20ab93https://sourceforge.net/p/fingerid/wiki/FingerID/<pre>--- v17 +++ v18 @@ -1,4 +1,3 @@ - News ---- @@ -15,7 +14,8 @@ [[download_button]] - +. + Abstract -------- </pre>Markus HeinonenMon, 13 Aug 2012 08:14:24 -0000https://sourceforge.netd02bb538a47daedb4bf4546f139d0dc71559b29dhttps://sourceforge.net/p/fingerid/wiki/FingerID/<pre>--- v16 +++ v17 @@ -1,4 +1,3 @@ - News ---- @@ -12,8 +11,11 @@ 16.07.2012: FingerID first release on 16.07.2012. Users can download the package at here [FingerID-1.0.tar.gz](http://sourceforge.net/projects/fingerid/files/FingerID-1.0.tar.gz/download). Users are required to install Openbabel and LibSVM before running the package. + [[download_button]] + + Abstract -------- </pre>Markus HeinonenMon, 13 Aug 2012 08:13:56 -0000https://sourceforge.net83f35f99aa2498b27341154623636ceb2440675ehttps://sourceforge.net/p/fingerid/wiki/FingerID/<pre>--- v15 +++ v16 @@ -1,3 +1,5 @@ + + News ---- @@ -9,6 +11,9 @@ 30.07.2012: Some bugs are fixed. The new package can be found here: [FingerID-1.1.tar.gz](http://sourceforge.net/projects/fingerid/files/FingerID-1.1.tar.gz/download). 16.07.2012: FingerID first release on 16.07.2012. Users can download the package at here [FingerID-1.0.tar.gz](http://sourceforge.net/projects/fingerid/files/FingerID-1.0.tar.gz/download). Users are required to install Openbabel and LibSVM before running the package. + +[[download_button]] + Abstract -------- </pre>Markus HeinonenMon, 13 Aug 2012 08:13:28 -0000https://sourceforge.netbfa6673cc56563cc3340a2a1473491022fb38a37https://sourceforge.net/p/fingerid/wiki/FingerID/<pre>--- v14 +++ v15 @@ -103,10 +103,3 @@ When you creat your own fingerprints dict, please use the FP2, FP3 and MACCS fingerprints (all together 528 fingerprints) in OpenBabel to make the fingerprints in dict and in the prediction comparable. - - - - - -[[project_admins]] - </pre>Markus HeinonenMon, 13 Aug 2012 08:04:50 -0000https://sourceforge.net42f62af5d76008536b90578179737e68b92bfb8bhttps://sourceforge.net/p/fingerid/wiki/FingerID/<pre>--- v13 +++ v14 @@ -29,6 +29,8 @@ * A representative dataset of MS/MS spectra with known precursors with closely matching instrument and operational parameters to the unknown MS/MS spectra. We recommend the [MassBank](http://www.massbank.jp/) database. * A fingerprint set. We provide a default set of FP3, FP4 and MACCS structural fingerprint set from OpenBabel consisting of 528 unique fingerprints. +* Currently the provided package works only in Linux environment. + The FingerID works by using the model to first predict a set of structural **fingerprints**, which are then used to query candidate structures from e.g. [PubChem](pubchem.ncbi.nlm.nih.gov/) using a statistical model. </pre>Markus HeinonenMon, 13 Aug 2012 08:04:32 -0000https://sourceforge.netcdb6d18411a09017b2ac496b6eda8b1c66fba316https://sourceforge.net/p/fingerid/wiki/FingerID/<pre>--- v12 +++ v13 @@ -33,7 +33,7 @@ The FingerID works by using the model to first predict a set of structural **fingerprints**, which are then used to query candidate structures from e.g. [PubChem](pubchem.ncbi.nlm.nih.gov/) using a statistical model. - + Package usage instruction </pre>Markus HeinonenMon, 13 Aug 2012 08:00:33 -0000https://sourceforge.netacf8e27f1bea96007224364f3512f104b0856d8dhttps://sourceforge.net/p/fingerid/wiki/FingerID/<pre>--- v11 +++ v12 @@ -1,4 +1,3 @@ - News ---- @@ -33,6 +32,8 @@ The FingerID works by using the model to first predict a set of structural **fingerprints**, which are then used to query candidate structures from e.g. [PubChem](pubchem.ncbi.nlm.nih.gov/) using a statistical model. + + Package usage instruction </pre>Markus HeinonenMon, 13 Aug 2012 07:59:38 -0000https://sourceforge.net8568e8084dff4a482f88815f3c7e0d692cd195a1https://sourceforge.net/p/fingerid/wiki/FingerID/<pre>--- v10 +++ v11 @@ -1,6 +1,3 @@ -FingerID -======== - News ---- @@ -14,19 +11,32 @@ 16.07.2012: FingerID first release on 16.07.2012. Users can download the package at here [FingerID-1.0.tar.gz](http://sourceforge.net/projects/fingerid/files/FingerID-1.0.tar.gz/download). Users are required to install Openbabel and LibSVM before running the package. +Abstract +-------- + +FingerID is framework for metabolite identification from MS/MS data. It's [published](http://bioinformatics.oxfordjournals.org/content/early/2012/07/18/bioinformatics.bts437.abstract) in Bioinformatics. An abstract from the paper: + +> Metabolite identification from tandem mass spectra is an important problem in metabolomics, underpinning subsequent metabolic modelling and network analysis. Yet, currently this task requires matching the observed spectrum against a database of reference spectra originating from similar equipment and closely matching operating parameters, a condition that is rarely satisfied in public repositories. Furthermore, the computational support for identification of molecules not present in reference databases is lacking. Recent efforts in assembling large public mass spectral databases such as MassBank have opened the door for the development of a new genre of metabolite identification methods. + +> We introduce a novel framework for prediction of molecular characteristics and identification of metabolites from tandem mass spectra using machine learning with the support vector machine (SVM). Our approach is to first predict a large set of [molecular fingerprints](http://www.dalkescientific.com/writings/diary/archive/2008/06/26/fingerprint_background.html) of the unknown metabolite from salient tandem mass spectral signals, and in the second step to use the predicted fingerprints for matching against large molecule databases, such as PubChem (see Figure 1). We demonstrate that a set of molecular fingerprints can be predicted with high accuracy, and that they are useful in de novo metabolite identification, where the reference database does not contain any spectra of the same molecule. + + Overview -------- -Metabolite identification from tandem mass spectra is an important problem in metabolomics, underpinning subsequent metabolic modelling and network analysis. Yet, currently this task requires matching the observed spectrum against a database of reference spectra originating from similar equipment and closely matching operating parameters, a condition that is rarely satisfied in public repositories. Furthermore, the computational support for identification of molecules not present in reference databases is lacking. Recent efforts in assembling large public mass spectral databases such as MassBank have opened the door for the development of a new genre of metabolite identification methods. +FingerID is a machine learning based framework for metabolite identification from MS/MS data. The method uses a state-of-the-art machine learning algorithms to first learn a *model* between a metabolite and its MS/MS peaks. The learned model can then be used to give predictions on the structural components of unknown metabolites, given their MS/MS measurements. +To use FingerID to identify metabolites from MS/MS you need: +* A representative dataset of MS/MS spectra with known precursors with closely matching instrument and operational parameters to the unknown MS/MS spectra. We recommend the [MassBank](http://www.massbank.jp/) database. +* A fingerprint set. We provide a default set of FP3, FP4 and MACCS structural fingerprint set from OpenBabel consisting of 528 unique fingerprints. -We introduce a novel framework for prediction of molecular characteristics and identification of metabolites from tandem mass spectra using machine learning with the support vector machine (SVM). Our approach is to first predict a large set of [molecular fingerprints](http://www.dalkescientific.com/writings/diary/archive/2008/06/26/fingerprint_background.html) of the unknown metabolite from salient tandem mass spectral signals, and in the second step to use the predicted fingerprints for matching against large molecule databases, such as PubChem (see Figure 1). We demonstrate that a set of molecular fingerprints can be predicted with high accuracy, and that they are useful in de novo metabolite identification, where the reference database does not contain any spectra of the same molecule. +The FingerID works by using the model to first predict a set of structural **fingerprints**, which are then used to query candidate structures from e.g. [PubChem](pubchem.ncbi.nlm.nih.gov/) using a statistical model. + Package usage instruction ------------------------- - We maintain two type of package. If you do not have OpenBabel-2.3.0 and LibSVM and not willing to install them, you can download our CDE package. Otherwise, you can download a much smaller standard package which you have to provide the OpenBabel path and LibSVM path as arguments. The related paper [Metabolites identification and fingerprint prediction via machine learning](http://bioinformatics.oxfordjournals.org/content/early/2012/07/18/bioinformatics.bts437.abstract) has more detail about the methods. </pre>Markus HeinonenMon, 13 Aug 2012 07:55:19 -0000https://sourceforge.net36750b712b32dd12eec3886b93b73d940028a627https://sourceforge.net/p/fingerid/wiki/FingerID/<pre>--- v9 +++ v10 @@ -81,9 +81,10 @@ Kegg_fp.dict is the python dict ( {"C00001":"0100110101010101010100....","C00002":"11010111000010101010...",...} ) taking database id as the key and corresponding fingperprints as the value. It's a binary file and can be loaded into memory, for instance, by pickle module. You can creat your own dict by the following python code: -f = open("kegg_fp.dict","wb") -pickle.write(f) -f.close() + :::python + f = open("kegg_fp.dict","wb") + pickle.write(f) + f.close() Notice that the kegg_fp.dict with this relase contains the fingerprints generated by OpenBabel-2.3.0 so to performe identification with this database, you have to use the same version of OpenBabel, that is 2.3.0. The fingerprints may be different in different version. If you are using another version of OpenBabel, you have to rebuild the kegg_fp.dict using your version of OpenBabel. </pre>Markus HeinonenMon, 13 Aug 2012 07:41:49 -0000https://sourceforge.netacea18b3e3e03b679963e0991b2dbb3ac4d672c3