Metabolomics::Banks::Knapsack(3)

NAME
Metabolomics::Banks::Knapsack - Perl extension for Knapsack bank

VERSION
Version 0.2 - Adding POD

SYNOPSIS
    use Metabolomics::Banks::Knapsack;

DESCRIPTION
        Metabolomics::Banks::Knapsack is a full package for Perl allowing to build a generic Perl bank object from Knapsack bank resource.

EXPORT
        use Metabolomics::Banks::Knapsack qw( :all ) ;

PUBLIC METHODS

  Metabolomics::Banks::Knapsack

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::Knapsack 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::Knapsack 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::Knapsack

PRIVATE_ONLY __refKnapsackEntry__
            ## Description : init a new blood exposome entry
            ## Input : void
            ## Output : refEntry
            ## Usage : $self->__refKnapsackEntry__() ;

PRIVATE_ONLY _getEntry_INCHIKEY
            ## Description : PRIVATE method _getEntry_INCHIKEY on a refKnapsackEntry object
            ## Input : void
            ## Output : $INCHIKEY
            ## Usage : my ( $INCHIKEY ) = $entry->_getEntry_INCHIKEY () ;

PRIVATE_ONLY _getEntry_EXACT_MASS
            ## Description : PRIVATE method _getEntry_EXACT_MASS on a refKnapsackEntry object
            ## Input : void
            ## Output : $EXACT_MASS
            ## Usage : my ( $EXACT_MASS ) = $entry->_getEntry_EXACT_MASS () ;

PRIVATE_ONLY _getEntry_KNAPSACK_ID
            ## Description : PRIVATE method _getEntry_CAS on a refKnapsackEntry object
            ## Input : void
            ## Output : $KNAPSACK_ID
            ## Usage : my ( $KNAPSACK_ID ) = $entry->_getEntry_KNAPSACK_ID () ;

PRIVATE_ONLY _getEntry_CAS
            ## Description : PRIVATE method _getEntry_CAS on a refKnapsackEntry object
            ## Input : void
            ## Output : $CAS
            ## Usage : my ( $CAS ) = $entry->_getEntry_CAS () ;

PRIVATE_ONLY _getEntry_MOLECULAR_FORMULA
            ## Description : PRIVATE method _getEntry_MOLECULAR_FORMULA on a refKnapsackEntry object
            ## Input : void
            ## Output : $COMPOUND_FORMULA
            ## Usage : my ( $COMPOUND_FORMULA ) = $entry->_getEntry_MOLECULAR_FORMULA () ;

PRIVATE_ONLY _getEntry_COMPOUND_NAME
            ## Description : PRIVATE method _getEntry_COMPOUND_NAME on a refKnapsackEntry object
            ## Input : void
            ## Output : $COMPOUND_NAME
            ## Usage : my ( $COMPOUND_NAME ) = $entry->_getEntry_COMPOUND_NAME () ;

AUTHOR
Franck Giacomoni, "<franck.giacomoni at inrae.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

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

    <https://rt.cpan.org/Public/Dist/Display.html?Name=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
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