File Coverage

blib/lib/Bio/RNA/BarMap/Mapping/FileMappingEntry.pm
Criterion Covered Total %
statement 11 11 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 15 15 100.0


line stmt bran cond sub pod time code
1             # Mini class for entries of the file mapping hash.
2             package Bio::RNA::BarMap::Mapping::FileMappingEntry;
3             our $VERSION = '0.04';
4              
5 5     5   162 use 5.012;
  5         27  
6 5     5   39 use warnings;
  5         13  
  5         158  
7              
8 5     5   28 use Moose;
  5         10  
  5         36  
9 5     5   34591 use namespace::autoclean;
  5         13  
  5         41  
10              
11              
12             has 'name' => (is => 'ro', required => 1);
13             # Ensure object is cleaned after use => use weak refs
14             has [qw(from to)] => (is => 'rw', weak_ref => 1);
15              
16             __PACKAGE__->meta->make_immutable;
17              
18             1;
19              
20             __END__
21              
22              
23             =pod
24              
25             =encoding UTF-8
26              
27             =head1 NAME
28              
29             Bio::RNA::BarMap::Mapping::FileMappingEntry - stores information about which
30             I<Barriers> file is mapped to which other I<Barriers> file.
31              
32             =head1 SYNOPSIS
33              
34             use v5.12; # for 'say'
35             use Bio::RNA::BarMap;
36              
37             my $file_mapping = Bio::RNA::BarMap::Mapping::FileMappingEntry->new(
38             name => '1.bar',
39             to => '2.bar',
40             from => undef,
41             )
42              
43             say 'File ', $file_mapping->name, ' is mapped to ', $file_mapping->to;
44              
45              
46             =head1 DESCRIPTION
47              
48             Internally used mini-class to store information about which I<Barriers> is
49             mapped to another. Stores both directions (mapped from, mapped to). The C<to>
50             and C<from> attributes may be undefined for the first and last file.
51              
52             =head1 AUTHOR
53              
54             Felix Kuehnl, C<< <felix at bioinf.uni-leipzig.de> >>
55              
56              
57             =head1 BUGS
58              
59             Please report any bugs or feature requests by raising an issue at
60             L<https://github.com/xileF1337/Bio-RNA-BarMap/issues>.
61              
62             You can also do so by mailing to C<bug-bio-rna-barmap at rt.cpan.org>,
63             or through the web interface at
64             L<https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Bio-RNA-BarMap>. I will be
65             notified, and then you'll automatically be notified of progress on your bug as
66             I make changes.
67              
68              
69             =head1 SUPPORT
70              
71             You can find documentation for this module with the perldoc command.
72              
73             perldoc Bio::RNA::BarMap
74              
75              
76             You can also look for information at the official BarMap website:
77              
78             L<https://www.tbi.univie.ac.at/RNA/bar_map/>
79              
80              
81             =over 4
82              
83             =item * Github: the official repository
84              
85             L<https://github.com/xileF1337/Bio-RNA-BarMap>
86              
87             =item * RT: CPAN's request tracker (report bugs here)
88              
89             L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=Bio-RNA-BarMap>
90              
91             =item * AnnoCPAN: Annotated CPAN documentation
92              
93             L<http://annocpan.org/dist/Bio-RNA-BarMap>
94              
95             =item * CPAN Ratings
96              
97             L<https://cpanratings.perl.org/d/Bio-RNA-BarMap>
98              
99             =item * Search CPAN
100              
101             L<https://metacpan.org/release/Bio-RNA-BarMap>
102              
103             =back
104              
105              
106             =head1 LICENSE AND COPYRIGHT
107              
108             Copyright 2019-2021 Felix Kuehnl.
109              
110             This program is free software: you can redistribute it and/or modify
111             it under the terms of the GNU General Public License as published by
112             the Free Software Foundation, either version 3 of the License, or
113             (at your option) any later version.
114              
115             This program is distributed in the hope that it will be useful,
116             but WITHOUT ANY WARRANTY; without even the implied warranty of
117             MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
118             GNU General Public License for more details.
119              
120             You should have received a copy of the GNU General Public License
121             along with this program. If not, see L<http://www.gnu.org/licenses/>.
122              
123              
124             =cut
125              
126             # End of Bio::RNA::BarMap::Mapping::FileMappingEntry