

STATS Java Library
==================

    Table of contents :

        I   ) Introduction

        II  ) Build instructions

        A   ) References

        B   ) About this project

        C   ) Contact and bug report manager

  ----------------------------------------------------------------------------

    I) Introduction

        The STATS Library is an implementation of the Statistical Tests for
        Proportions Comparison presented by E. D. Taillard, Ph. Waelti and
        J. Zuber in [1].

        Online implementation can be found at :

            http://qualopt.heig-vd.ch

  ----------------------------------------------------------------------------

    II) Build instructions

        Java is (should be) protable, so no platform problem...

        * Unix / Linux

            Customize the Makefile (default config should be OK) and type
            `make` in the top level directory of the distribution.

            Development compiler was Sun JDK 1.5.0 (FreeBSD)

            When compilation is done, following message appear

            /* ---------------------------------------------------- */

             Build done :

                     Library         -> ./library/STATS.jar
                     Library JavaDoc -> ./library/javadoc/index.html
                     Console and GUI examples in ./console and ./gui

             /* ---------------------------------------------------- */

             indicating where to find library, ...

             The library documentation is generated using JavaDoc, browse
             index.html for the library documentation.

             An example on how to use the library can be found in './console'
             or './gui' directories.

             To launch the GUI for example, go in the './gui' directory and
             type 'make'. See 'Makefile' for the Java parameters needed

        * Windows

             Use a console to compile library and the examples.

             In 'library' :

                    1) javac STATS.java
                    2) jar cf STATS.jar *.class
                    3) javadoc -d javadoc\ *.java

             In 'console' :

                    1) set CLASSPATH=%CLASSPATH%;.;..\library
                    2) javac STATSTest.java
                    3) java STATSTest

             In 'gui' :

                    1) set CLASSPATH=%CLASSPATH%;.;..\library
                    2) javac STATSInterface.java
                    3) java STATSInterface

        * Or...

             Don't want to use JAR file, copy library/*.java files in your
             project directory...

  ----------------------------------------------------------------------------

    A) References

        [1] E. D. Taillard, Ph. Waelti, J. Zuber, "Few statistical tests
            for proportions comparison", Technical report, HEIG-Vd, 2006

  ----------------------------------------------------------------------------

    B) About this project

        QualOpt project is supported by the strategic founds of the Applied
        University of Western Switzerland (HES-SO), grant QUALOPT-11731

  ----------------------------------------------------------------------------

    C) Contact and bug report manager

        Philippe Waelti
        mailto: philippe [dot] waelti [ at] heig-vd [dot] ch

        Thanks for your bug reports !

