The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Bio-RNA-Treekin-0.05
River stage zero No dependents
++
/ Bio::RNA::Treekin::MultiRecord

NAME

Bio::RNA::Treekin::MultiRecord - Stream records from a multi-record Treekin file.

SYNOPSIS

    use Bio::RNA::Treekin;

    # Open the multi-record Treekin file.
    my $record_stream = Bio::RNA::Treekin::MultiRecord->new(
                            'multi_treekin.out');

    # Iterate over the individual records.
    while (defined (my $record = $record_stream->next)) {
        ...         # do something with the Treekin record
    }

DESCRIPTION

This class provides a stream to read individual records from multi-record Treekin files as generated by the RNA folding simulation tool BarMap.

METHODS

This class extends IO::File::RecordStream and offers the same methods. Below, only the differences are described.

Bio::RNA::Treekin::MultiRecord->new($treekin_file)

Bio::RNA::Treekin::MultiRecord->new($treekin_handle)

Constructs a new record stream for a multi-Treekin file, i. e. an output file as generated by the BarMap scripts, which were developed by the Theoretical Biochemistry Group (TBI) of the University of Vienna. These files look like a concatenation of multiple regular Treekin files, where the individual file contents are separated by a line consisting only of "&" (a syntax borrowed from the Grace visualization software).

Both a path to the file or a handle can be passed to the constructor.

$record_stream->next

Return the next Treekin record from the multi-record Treekin file, represented as an object of class Bio::RNA::Treekin::Record.

AUTHOR

Felix Kuehnl, <felix@bioinf.uni-leipzig.de>

BUGS

Please report any bugs or feature requests by raising an issue at https://github.com/xileF1337/Bio-RNA-Treekin/issues.

You can also do so by mailing to bug-bio-rna-treekin at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Bio-RNA-Treekin. 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 Bio::RNA::Treekin

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2019-2021 Felix Kuehnl.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.