Text::NSP::Measures::2D::Fisher2::twotailed - Perl module implementation of the two-sided


Text-NSP documentation Contained in the Text-NSP distribution.

Index


Code Index:

NAME

Top

Text::NSP::Measures::2D::Fisher2::twotailed - Perl module implementation of the two-sided Fisher's exact test (Deprecated).

SYNOPSIS

Top

Basic Usage

  use Text::NSP::Measures::2D::Fisher2::twotailed;

  my $npp = 60; my $n1p = 20; my $np1 = 20;  my $n11 = 10;

  $twotailed_value = calculateStatistic( n11=>$n11,
                                      n1p=>$n1p,
                                      np1=>$np1,
                                      npp=>$npp);

  if( ($errorCode = getErrorCode()))
  {
    print STDERR $errorCode." - ".getErrorMessage();
  }
  else
  {
    print getStatisticName."value for bigram is ".$twotailed_value;
  }




DESCRIPTION

Top

This module provides a naive implementation of the fishers twotailed exact tests. That is the implementation does not have any optimizations for performance. This will compute the factorials and the hypergeometric measures using direct multiplications.

This measure should be used if you need exact values without any rounding errors, and you are not worried about the performance of the measure, otherwise use the implementations under the Text::NSP::Measures::2D::Fisher module. To use this implementation, you will have to specify the entire module name. Usage:

statistic.pl Text::NSP::Measures::Fisher2::twotailed dest.txt source.cnt

Assume that the frequency count data associated with a bigram <word1><word2> is stored in a 2x2 contingency table:

          word2   ~word2
  word1    n11      n12 | n1p
 ~word1    n21      n22 | n2p
           --------------
           np1      np2   npp

where n11 is the number of times <word1><word2> occur together, and n12 is the number of times <word1> occurs with some word other than word2, and n1p is the number of times in total that word1 occurs as the first word in a bigram.

The fishers exact tests are calculated by fixing the marginal totals and computing the hypergeometric probabilities for all the possible contingency tables,

A twotailed fishers test is calculated by adding the probabilities of all the contingency tables with probabilities less than the probability of the observed table. The twotailed fishers test tells us how likely it would be to observe an contingency table which is less probable than the current table.

Methods

calculateStatistic() - This method computes the right sided Fishers exact test.

INPUT PARAMS : $count_values .. Reference of an array containing the count values computed by the count.pl program.

RETURN VALUES : $twotailed .. Twotailed Fisher value.

getStatisticName()

Returns the name of this statistic

INPUT PARAMS : none

RETURN VALUES : $name .. Name of the measure.

AUTHOR

Top

Ted Pedersen, University of Minnesota Duluth<tpederse@d.umn.edu>

Satanjeev Banerjee, Carnegie Mellon University<satanjeev@cmu.edu>

Amruta Purandare, University of Pittsburgh<amruta@cs.pitt.edu>

Bridget Thomson-McInnes, University of Minnesota Twin Cities<bthompson@d.umn.edu>

Saiyam Kohli, University of Minnesota Duluth<kohli003@d.umn.edu>

HISTORY

Top

Last updated: $Id: twotailed.pm,v 1.10 2008/03/26 17:24:15 tpederse Exp $

BUGS

Top

SEE ALSO

Top

http://groups.yahoo.com/group/ngram/

http://www.d.umn.edu/~tpederse/nsp.html

COPYRIGHT

Top


Text-NSP documentation Contained in the Text-NSP distribution.
package Text::NSP::Measures::2D::Fisher2::twotailed;


use Text::NSP::Measures::2D::Fisher2;
use strict;
use Carp;
use warnings;
no warnings 'redefine';
require Exporter;

our ($VERSION, @EXPORT, @ISA);

@ISA  = qw(Exporter);

@EXPORT = qw(initializeStatistic calculateStatistic
             getErrorCode getErrorMessage getStatisticName);

$VERSION = '0.97';


sub calculateStatistic
{
  my %values = @_;

  my $probabilities;

  # computes and returns the observed and marginal values from
  # the frequency combination values. returns 0 if there is an
  # error in the computation or the values are inconsistent.
  if( !(Text::NSP::Measures::2D::Fisher2::getValues(\%values)) )
  {
    return;
  }


  my $final_limit = ($n1p < $np1) ? $n1p : $np1;
  my $n11_org = $n11;

  my $n11_start = $n1p + $np1 - $npp;
  if($n11_start<0)
  {
    $n11_start = 0;
  }

  if( !($probabilities = Text::NSP::Measures::2D::Fisher2::computeDistribution($n11_start, $final_limit)))
  {
      return;
  }

  my $value;

  my $ttfisher=0;

  foreach $value (sort { $a <=> $b } values %$probabilities)
  {
    if($value > $probabilities->{$n11_org})
    {
      next;
    }
    $ttfisher += $value;
  }

  return $ttfisher;
}


sub getStatisticName
{
    return "Two Tailed Fisher";
}



1;
__END__