The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Metabolomics-Fragment-Annotation-0.6.6
River stage zero No dependents
++
/ Metabolomics::Banks::BloodExposome

NAME

Metabolomics::Banks::BloodExposome - Perl extension for BloodExposome bank

VERSION

Version 0.2 - Adding POD Version 0.3 - Completing object properties

SYNOPSIS

    use Metabolomics::Banks::BloodExposome;

DESCRIPTION

        Metabolomics::Banks::BloodExposome is a full package for Perl allowing to build a generic Perl bank object from Blood exposome bank resource.

EXPORT

use Metabolomics::Banks::BloodExposome qw( :all ) ;

PUBLIC METHODS

Metabolomics::Fragment::Annotation

new
        ## Description : new
        ## Input : $self
        ## Ouput : bless $self ;
        ## Usage : new() ;
getMetabolitesFromSource
        ## Description : get the list of metabolite entries from $source file and set the Metabolomics::Banks::BloodExposome object
        ## Input : $source (file from the metabolomics-references project)
        ## Output : an int as $entriesNb
        ## Usage : my ( $entriesNb ) = $self->getMetabolitesFromSource ( $source ) ;
METHOD buildTheoPeakBankFromEntries
        ## Description : building from a Metabolomics::Banks::BloodExposome object, a bank integrating each potential entry in a metabolomics format (POSITIVE or NEGATIVE forms)
        ## Input : $queryMode [POS|NEG]
        ## Output : int as $entryNb
        ## Usage : my $nb = $oBank->buildTheoPeakBankFromEntries() ;

PRIVATE METHODS

Metabolomics::Banks::BloodExposome

PRIVATE_ONLY __refBloodExposomeEntry__
        ## Description : init a new blood exposome entry
        ## Input : void 
        ## Output : refEntry
        ## Usage : $self->__refBloodExposomeEntry__() ;
PRIVATE_ONLY _getEntry_EXACT_MASS
        ## Description : PRIVATE method _getEntry_EXACT_MASS on a refBloodExposomeEntry object
        ## Input : void
        ## Output : $VALUE
        ## Usage : my ( $VALUE ) = $entry->_getEntry_EXACT_MASS () ;
PRIVATE_ONLY _getEntry_CHARGE
        ## Description : PRIVATE method _getEntry_CHARGE on a refBloodExposomeEntry object
        ## Input : void
        ## Output : $VALUE
        ## Usage : my ( $VALUE ) = $entry->_getEntry_CHARGE () ;
PRIVATE_ONLY _getEntry_COMPOUND_NAME
        ## Description : PRIVATE method _getEntry_COMPOUND_NAME on a refBloodExposomeEntry object
        ## Input : void
        ## Output : $COMPOUND_NAME
        ## Usage : my ( $COMPOUND_NAME ) = $entry->_getEntry_COMPOUND_NAME () ;
PRIVATE_ONLY _getEntry_MOLECULAR_FORMULA
        ## Description : PRIVATE method _getEntry_MOLECULAR_FORMULA on a refBloodExposomeEntry object
        ## Input : void
        ## Output : $VALUE
        ## Usage : my ( $VALUE ) = $entry->_getEntry_MOLECULAR_FORMULA () ;
PRIVATE_ONLY _getEntry_CANONICAL_SMILES
        ## Description : PRIVATE method _getEntry_CANONICAL_SMILES on a refBloodExposomeEntry object
        ## Input : void
        ## Output : $VALUE
        ## Usage : my ( $VALUE ) = $entry->_getEntry_CANONICAL_SMILES () ;
PRIVATE_ONLY _getEntry_INCHIKEY
        ## Description : PRIVATE method _getEntry_INCHIKEY on a refBloodExposomeEntry object
        ## Input : void
        ## Output : $VALUE
        ## Usage : my ( $VALUE ) = $entry->_getEntry_INCHIKEY () ;
PRIVATE_ONLY _getEntry_PUBCHEM_CID
        ## Description : PRIVATE method _getEntry_PUBCHEM_CID on a refBloodExposomeEntry object
        ## Input : void
        ## Output : $VALUE
        ## Usage : my ( $VALUE ) = $entry->_getEntry_PUBCHEM_CID () ;

AUTHOR

Franck Giacomoni, <franck.giacomoni at inra.fr>

SEE ALSO

All information about Metabolomics::Fragment would be find here: https://services.pfem.clermont.inra.fr/gitlab/fgiacomoni/metabolomics-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/Public/Dist/Display.html?Name=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

ACKNOWLEDGEMENTS

Thank you to INRAE and All metabolomics colleagues.

LICENSE AND COPYRIGHT

CeCILL Copyright (C) 2019 by Franck Giacomoni

Initiated by Franck Giacomoni

followed by INRA PFEM team

Web Site = INRA PFEM