Bio::Tools::EUtilities::Summary

NAME

Bio::Tools::EUtilities::Summary − Class for handling data output (XML) from esummary.

VERSION

version 1.75

SYNOPSIS

  #### should not create instance directly; Bio::Tools::EUtilities does this ####
  my $esum = Bio::Tools::EUtilities−>new(−eutil => 'esummary',
                                         −file => 'summary.xml');
  # can also use '−response' (for HTTP::Response objects) or '−fh' (for filehandles)
  while (my $docsum = $esum−>next_DocSum) {
      my $id = $docsum−>get_ids;  # EUtilDataI compliant method, returns docsum ID
      my @names = $docsum−>get_item_names;
  }

DESCRIPTION

This class handles data output ( XML ) from esummary.

esummary retrieves information in the form of document summaries (docsums) when passed a list of primary IDs or if using a previous search history.

This module breaks down the returned data from esummary into individual document summaries per ID (using a DocSum object). As the data in a docsum can be nested, subclasses of DocSums (Item, ListItem, Structure) are also present.

Further documentation for Link and Field subclass methods is included below.

to_string

 Title    : to_string
 Usage    : $foo−>to_string()
 Function : converts current object to string
 Returns  : none
 Args     : (optional) simple data for text formatting
 Note     : Used generally for debugging and for the print_* methods

FEEDBACK

Mailing lists
User feedback is an integral part of the evolution of this and other Bioperl modules. Send your comments and suggestions preferably to the Bioperl mailing list. Your participation is much appreciated.

  bioperl−l AT bioperl DOT org                  − General discussion
  http://bioperl.org/wiki/Mailing_lists  − About the mailing lists

Support
Please direct usage questions or support issues to the mailing list: bioperl−l AT bioperl DOT org

rather than to the module maintainer directly. Many experienced and reponsive experts will be able look at the problem and quickly address it. Please include a thorough description of the problem with code and data examples if at all possible.

Reporting bugs
Report bugs to the Bioperl bug tracking system to help us keep track of the bugs and their resolution. Bug reports can be submitted via the web:

  https://github.com/bioperl/%%7Bdist%7D

AUTHOR

Chris Fields <cjfields AT bioperl DOT org>

COPYRIGHT

This software is copyright (c) 2006−2013 by Chris Fields.

This software is available under the same terms as the perl 5 programming language system itself.