Skip to content

Commit

Permalink
POD skeletons
Browse files Browse the repository at this point in the history
  • Loading branch information
bretonics committed May 5, 2017
1 parent 407d1af commit 19df9ca
Showing 1 changed file with 48 additions and 7 deletions.
55 changes: 48 additions & 7 deletions Bioinformatics/Seq/Features.pm
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,39 @@ use MyIO;
#
# =============================================================================

=head1 NAME
# Gets features provided a sequence file
Features - package to deal with sequence file features.
=head1 SYNOPSIS
use Bioinformatics::Seq::Features;
=head1 DESCRIPTION
This module was designed to save or print Genbank file features for each CDS to a file or stdout.
=head1 EXPORTS
=head2 Default Behaviors
use Bioinformatics::Seq::Features;
=head1 METHODS
=head2 getFeatures
Arg [1] :
Example :
Description : Gets features provided a sequence fileS
Returntype :
Status : Stable
=cut
sub getFeatures {
my (@files) = @_;
for my $file (@files) {
Expand All @@ -34,8 +65,19 @@ sub getFeatures {
}
}

=head2 lookUpFeatures
Arg [1] :
Example :
# Gets features provided a sequence object
Description : Gets features provided a sequence object
Returntype :
Status : Stable
=cut
sub lookUpFeatures {
my ($seqObjects, $task) = @_;
my @seqObjects = @$seqObjects;
Expand Down Expand Up @@ -93,7 +135,6 @@ sub _saveFeatures {
}
}


# Print features to STDOUT
sub _printFeatures {
my ($feat) = @_;
Expand All @@ -109,21 +150,21 @@ sub _printFeatures {

=head1 COPYRIGHT AND LICENSE
Andres Breton (C)
Andres Breton (C) 2017
[LICENSE]
=head1 CONTACT
Please email comments or questions to Andres Breton, <dev@andresbreton.com>
Please email comments or questions to Andres Breton, dev@andresbreton.com
=head1 SETTING PATH
If PERL5LIB was not set, do something like this:
use FindBin; use lib "$FindBin::RealBin/lib";
use FindBin; use lib "$FindBin::RealBin";
This finds and uses subdirectory 'lib' in current directory as library location
This finds and uses current directoy as library location
=cut

Expand Down

0 comments on commit 19df9ca

Please sign in to comment.