sources/pairwise/Pairwise/Pairwise.pm

   1 package Pairwise;
   2
   3 use 5.008;
   4 use strict;
   5 use warnings;
   6
   7 use base qw(Exporter);
   8
   9 our @EXPORT_OK = qw(pairwise);
  10 our $VERSION = '0.01';
  11
  12 require XSLoader;
  13 XSLoader::load('Pairwise', $VERSION);
  14
  15 1;
  16 __END__
  17
  18 =head1 NAME
  19
  20 Pairwise - Perl extension for doing pairwise comparisons of sequences
  21
  22 =head1 SYNOPSIS
  23
  24   use Pairwise qw(pairwise);
  25   open my $fh "fasta_file" or die $!;
  26
  27   my ($number, @distances) = pairwise $fh;
  28   my @ids = splice 0, $number, @distances;
  29
  30 =head1 ABSTRACT
  31
  32 Gives various C based methods for pairwise comparison and identity scores between two sequences.
  33
  34 =head1 DESCRIPTION
  35
  36 This module implements a C based pairwise comparison algorithim for biological sequences. Gaps in the input sequences should be represented as "-" characters. The sequences should be in FASTA format.
  37
  38 =head2 EXPORT
  39
  40 None by default.
  41
  42 =head1 SEE ALSO
  43
  44 http://www.compbio.dundee.ac.uk
  45
  46 =head1 AUTHOR
  47
  48 Jonathan Barber <jon@compbio.dundee.ac.uk>
  49
  50 =head1 COPYRIGHT AND LICENSE
  51
  52 Copyright 2003 by Jonathan Barber <jon@compbio.dundee.ac.uk>
  53
  54 This library is free software; you can redistribute it and/or modify
  55 it under the same terms as Perl itself.
  56
  57 =cut