Metabolomics::Fragment::Annotation(3)

NAME
Metabolomics::Fragment::Annotation - Perl extension for fragment annotation in metabolomics

VERSION
Version 0.6.1

SYNOPSIS
Note that this documentation is intended as a reference to the module.

        Metabolomics::Banks::MaConDa is allowing to build a contaminant database usefull to clean your LC-MS filtered peak list:

                my $oBank = Metabolomics::Banks::MaConDa->new() ;                       # init the bank object
                $oBank->getContaminantsExtensiveFromSource() ;                  # get theorical contaminants from the extensive version of MaConDa database
                $oNewBank->buildTheoPeakBankFromContaminants($queryMode) ;                      # build theorical bank (ION | NEUTRAL)

        Metabolomics::Banks::BloodExposome is giving access to a local Blood Exposome database (Cf publication here L<https://doi.org/10.1289/EHP4713>):

                my $oBank = Metabolomics::Banks::BloodExposome->new() ;                 # init the bank object
                $oBank->getMetabolitesFromSource($source) ;                     # get theorical metabolites from local database version
                $oBank->buildTheoPeakBankFromEntries($IonMode) ;                        # produce the new theorical bank depending of chosen acquisition mode

        Metabolomics::Banks::Knapsack is giving access to a local Knapsack database (Cf publication here L<https://doi.org/10.1093/pcp/pcr165>):

                my $oBank = Metabolomics::Banks::Knapsack->new() ;
                $oBank->getKSMetabolitesFromSource($source) ;
                $oBank->buildTheoPeakBankFromKnapsack($IonMode) ;

        Metabolomics::Banks::AbInitioFragments is used abinitio fragment, adduct and isotope annotation:

                my $oBank = Metabolomics::Banks::AbInitioFragments->new() ;                     # init the bank object
                $oBank->getFragmentsFromSource() ;                      # get theorical fragment/adduct/isotopes loses or adds
                $oBank->buildTheoPeakBankFromFragments($mzMolecule, $mode, $stateMolecule) ;                    # produce the new theorical bank from neutral (or not) molecule mass

        When resources are built, Metabolomics::Fragment::Annotation drives the annotation process:
                $oBank->parsingMsFragments($inputFile, $asHeader, $mzCol) ;                     # get exprimental mz listing to annotate
                my $oAnalysis = Metabolomics::Fragment::Annotation->new($oBank) ;                       # init analysis object
                $oAnalysis->compareExpMzToTheoMzList('PPM', $ppmError) ;                        # compare theorical bank vs experimental bank

DESCRIPTION
Metabolomics::Fragment::Annotation is a full package for Perl dev allowing MS fragments annotation with ab initio database, contaminant and public metabolites ressources.

All resources used are described and available here:

Metabolomics::Fragment::Annotation 0.6.x
Metabolomics::Fragment::Annotation Perl package proposes several databases and algorithms to help metabolomics identification step:

  Using BloodExposome database
The exposome represents the sum of all exposures during the life-span of an organism (from chemicals to microbes, viruses, radiation and other sources). Exposome chemicals are a major component of the exposome and are known to alter activities of cellular pathways and structures. In humans, exposome chemicals are transported throughout the body, linking chemical exposures to phenotypes such as such as cancer, ageing or diabetes. The Blood Exposome Database (<https://bloodexposome.org>) is a collection of chemical compounds and associated information that were automatically extracted by text mining the content of PubMed and PubChem databases. The database also unifies chemical lists from metabolomics, systems biology, environmental epidemiology, occupational expossure, toxiology and nutrition fields. This db is developped and supported by Dinesh Kumar Barupal and Oliver Fiehn. The database can be used in following applications - 1) to rank chemicals for building target libraries and expand metabolomics assays 2) to associate blood compounds with phenotypes 3) to get detailed descriptions about chemicals 4) to prepare lists of blood chemical lists by chemical classes and associated properties. 5) to interpret of metabolomics datasets from plasma or serum analyses 6) to prioritize chemicals for hazard assessments.

Metabolomics::Banks::BloodExposome is giving access to a up to date Blood Exposome database stored in metabolomics::references package

        # init the bank object

        my $oBank = Metabolomics::Banks::BloodExposome->new() ;

        # Get theorical metabolites from local database version

        $oBank->getMetabolitesFromSource($source) ;

        # produce the new theorical bank depending of chosen acquisition mode

        $oBank->buildTheoPeakBankFromEntries($IonMode) ;

When resources are built, Metabolomics::Fragment::Annotation drives the annotation process:

        # Get experimental mz listing to annotate

        $oBank->parsingMsFragments($inputFile, $asHeader, $mzCol) ;

        # init analysis object based on a Knapsack bank object

        my $oAnalysis = Metabolomics::Fragment::Annotation->new($oBank) ;

        # Compare theorical bank vs experimental bank with a delta on mz (Da or PPM are both supported)

        $oAnalysis->compareExpMzToTheoMzList('PPM', $ppmError) ;

Intensity and retention time variables are not used in this annotation because the reference bank does not store such features.

  Using KnapSack database
KnapSack database is a comprehensive Species-Metabolite Relationship Database with more than 53,000 metabolites and 128,000 metabolite-species pair entities. This db is developped and supported by Yukiko Nakamura, Hiroko Asahi, Md. Altaf-Ul-Amin, Ken Kurokawa and Shigehiko Kanaya. This resource is very useful for plant or natural product community trying to identify metabolites in samples analysed by LC-MS

        # init the bank object

        my $oBank = Metabolomics::Banks::Knapsack->new()

        # get theorical metabolites from last database version (crawled by metabolomics::references package)

        $oBank->getKSMetabolitesFromSource($source) ;

        # build potential candidates depending of your acquisition mode used on LC-MS instrument and produce the new theorical bank
        # Only POSITIVE or NEGATIVE is today supported - - "BOTH" does not work

        $oBank->buildTheoPeakBankFromKnapsack($IonMode) ;

When resources are built, Metabolomics::Fragment::Annotation drives the annotation process:

        # Get experimental mz listing to annotate

        $oBank->parsingMsFragments($inputFile, $asHeader, $mzCol) ;

        # init analysis object based on a Knapsack bank object

        my $oAnalysis = Metabolomics::Fragment::Annotation->new($oBank) ;

        # Compare theorical bank vs experimental bank with a delta on mz (Da or PPM are both supported)

        $oAnalysis->compareExpMzToTheoMzList('PPM', $ppmError) ;

Intensity and retention time variables are not used in this annotation because the reference bank does not store such features.

PUBLIC METHODS

  Metabolomics::Fragment::Annotation

new
            ## Description : new
            ## Input : $self
            ## Ouput : bless $self ;
            ## Usage : my $oAnalysis = Metabolomics::Fragment::Annotation->new($oBank) ;

compareExpMzToTheoMzList
            ## Description : comparing two lists of mzs (theo and experimental) with a mz delta
            ## Input : $deltaValue, $deltaType
            ## Output : $oAnalysis with annotation results
            ## Usage : $oAnalysis->compareExpMzToTheoMzList ( $deltaValue, $deltaType ) ;

writeTabularWithPeakBankObject
            ## Description : write a full tabular file from a template and mapping peak bank objects features
            ## Input : $oBank, $templateTabular, $tabular
            ## Output : $tabular
            ## Usage : my ( $tabular ) = $oBank->writeTabularWithPeakBankObject ( $templateTabular, $tabular ) ;

writeFullTabularWithPeakBankObject
            ## Description : write a output containing the input data and new column concerning annotation work
            ## Input : $oBank, $inputData, $templateTabular, $tabular
            ## Output : $tabular
            ## Usage : my ( $tabular ) = $oBank->writeFullTabularWithPeakBankObject ( $inputData, $templateTabular, $tabular ) ;

PRIVATE METHODS

  Metabolomics::Fragment::Annotation

PRIVATE_ONLY _getPeaksToAnnotated
            ## Description : get a specific list of peaks from the Annotation analysis object
            ## Input : $self, $type
            ## Output : $peakList
            ## Usage : my ( $peakList ) = $oAnalysis->_getPeakList ($type) ;

PRIVATE_ONLY _getTEMPLATE_TABULAR_FIELDS
            ## Description : get all fields of the tabular template file
            ## Input : $template
            ## Output : $fields
            ## Usage : my ( $fields ) = _getTEMPLATE_TABULAR_FIELDS ( $template ) ;

PRIVATE_ONLY _mapPeakListWithTemplateFields
            ## Description : map any PeakList with any template fields from tabular
            ## Input : $fields, $peakList
            ## Output : $rows
            ## Usage : my ( $rows ) = _mapPeakListWithTemplateFields ( $fields, $peakList ) ;

PRIVATE_ONLY _mz_delta_conversion
            ## Description : returns the minimum and maximum mass according to the delta
            ## Input : \$mass, \$delta_type, \$mz_delta
            ## Output : \$min, \$max
            ## Usage : ($min, $max)= mz_delta_conversion($mass, $delta_type, $mz_delta) ;

PRIVATE_ONLY _computeMzDeltaInMmu
            ## Description : compute a delta (Da) between exp. mz and calc. mz
            ## based on http://www.waters.com/waters/en_GB/Mass-Accuracy-and-Resolution/nav.htm?cid=10091028&locale=en_GB
            ## Other ref : https://www.sciencedirect.com/science/article/pii/S1044030510004022
            ## Input : $expMz, $calcMz
            ## Output : $mzDeltaDa
            ## Usage : my ( $mzDeltaDa ) = _computeMzDeltaInMmu ( $expMz, $calcMz ) ;

PRIVATE_ONLY computeMzDeltaInPpm
            ## Description : compute a delta (PPM) between exp. mz and calc. mz - Δm/Monoisotopic calculated exact mass ×106
            ## Input : $expMz, $calcMz
            ## Output : $mzDeltaPpm
            ## Usage : my ( $mzDeltaPpm ) = computeMzDeltaInPpm ( $expMz, $calcMz ) ;

AUTHOR
Franck Giacomoni, "<franck.giacomoni at inrae.fr>" Biological computing & Metabolomics INRAE - UMR 1019 Human Nutrition Unit – Metabolism Exploration Platform MetaboHUB – Clermont

SEE ALSO
All information about FragNot should be find here: https://services.pfem.clermont.inra.fr/gitlab/fgiacomoni/fragnot

BUGS
Please report any bugs or feature requests to "bug-metabolomics-fragment-annotation at rt.cpan.org", or through the web interface at <https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Metabolomics-Fragment-Annotation>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT
You can find documentation for this module with the perldoc command.

    perldoc Metabolomics::Fragment::Annotation

•   RT: CPAN's request tracker (report bugs here)

    <https://rt.cpan.org/NoAuth/Bugs.html?Dist=Metabolomics-Fragment-Annotation>

•   AnnoCPAN: Annotated CPAN documentation

    <http://annocpan.org/dist/Metabolomics-Fragment-Annotation>

•   CPAN Ratings

    <https://cpanratings.perl.org/d/Metabolomics-Fragment-Annotation>

•   Search CPAN

    <https://metacpan.org/release/Metabolomics-Fragment-Annotation>

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT
CeCILL Copyright (C) 2019 by Franck Giacomoni

Initiated by Franck Giacomoni

followed by INRAE PFEM team

Web Site = INRAE PFEM

POD ERRORS
Hey! The above document had some coding errors, which are explained below:

Around line 469:
    You forgot a '=back' before '=head1'

Around line 692:
    You forgot a '=back' before '=head1'