Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Merge pull request #6 from PDLPorters/gh-sprucing
add badges to README and rename to Markdown file
  • Loading branch information
mohawk2 committed Aug 29, 2015
2 parents 00054ae + 71405c8 commit 08cf4a4
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 18 deletions.
2 changes: 1 addition & 1 deletion MANIFEST
Expand Up @@ -2,7 +2,7 @@ Changes
MANIFEST
Makefile.PL
add_doc.pl
README
README.md
Stats.pm
Basic/stats_basic.pp
Basic/Makefile.PL
Expand Down
44 changes: 27 additions & 17 deletions README → README.md
@@ -1,29 +1,40 @@
PDL-Stats
# PDL-Stats

| OS | Build status |
|:-------:|--------------:|
| Linux | [![Build Status](https://travis-ci.org/PDLPorters/PDL-Stats.png?branch=master)](https://travis-ci.org/PDLPorters/PDL-Stats) |
| Windows | [![Build status](https://ci.appveyor.com/api/projects/status/0vyo5c507j1ig690/branch/master?svg=true)](https://ci.appveyor.com/project/zmughal/pdl-stats/branch/master) |

[![Coverage Status](https://coveralls.io/repos/PDLPorters/PDL-Stats/badge.svg?branch=master&service=github)](https://coveralls.io/github/PDLPorters/PDL-Stats?branch=master)
[![CPAN version](https://badge.fury.io/pl/PDL-Stats.svg)](https://metacpan.org/pod/PDL::Stats)


This is a collection of statistics modules in Perl Data Language, with a quick-start guide for non-PDL people.

They make perldl--the simple shell for PDL--work like a teenie weenie R, but with PDL threading--"the fast (and automagic) vectorised iteration of 'elementary operations' over arbitrary slices of multidimensional data"--on procedures including t-test, ordinary least squares regression, and kmeans.

Of course, they also work in perl scripts.

DEPENDENCIES
## DEPENDENCIES

- PDL

PDL
Perl Data Language. Preferably installed with a Fortran compiler. A few methods (logistic regression and all plotting methods) will only work with a Fortran compiler and some methods (ordinary least squares regression and pca) work much faster with a Fortran compiler.
Perl Data Language. Preferably installed with a Fortran compiler. A few methods (logistic regression and all plotting methods) will only work with a Fortran compiler and some methods (ordinary least squares regression and pca) work much faster with a Fortran compiler.

The recommended PDL version is 2.4.8. PDL-2.4.7 introduced a bug in lu_decomp() which caused a few functions in PDL::Stats::GLM to fail. Otherwise the minimum compatible PDL version is 2.4.4.
The recommended PDL version is 2.4.8. PDL-2.4.7 introduced a bug in lu_decomp() which caused a few functions in PDL::Stats::GLM to fail. Otherwise the minimum compatible PDL version is 2.4.4.

GSL (Optional)
GNU Scientific Library. This is required by PDL::Stats::Distr and PDL::GSL::CDF, the latter of which provides p-values for PDL::Stats::GLM. GSL is otherwise NOT required for the core PDL::Stats modules to work, ie Basic, Kmeans, and GLM.
- GSL (Optional)

PGPLOT (Optional)
GNU Scientific Library. This is required by PDL::Stats::Distr and PDL::GSL::CDF, the latter of which provides p-values for PDL::Stats::GLM. GSL is otherwise NOT required for the core PDL::Stats modules to work, ie Basic, Kmeans, and GLM.

PDL-Stats currently uses PGPLOT for plotting. There are three pgplot/PGPLOT modules, which cause much confusion upon installation. First there is the pgplot Fortran library. Then there is the perl PGPLOT module, which is the perl interface to pgplot. Finally there is PDL::Graphics::PGPLOT, which depends on pgplot and PGPLOT, that PDL-Stats uses for plotting.
- PGPLOT (Optional)

INSTALLATION
PDL-Stats currently uses PGPLOT for plotting. There are three pgplot/PGPLOT modules, which cause much confusion upon installation. First there is the pgplot Fortran library. Then there is the perl PGPLOT module, which is the perl interface to pgplot. Finally there is PDL::Graphics::PGPLOT, which depends on pgplot and PGPLOT, that PDL-Stats uses for plotting.

## INSTALLATION

### *nix

*nix
----
For standard perl module installation in *nix environment form source, to install all included modules, extract the files from the archive by entering this at a shell,

tar xvf PDL-Stats-xxx.tar.gz
Expand All @@ -50,16 +61,16 @@ then add /home/user/my_perl_lib to your PERL5LIB environment variable.

If you have trouble installing PDL, you can look for help at the PDL wiki or PDL mailing list.

Wiondows
--------
### Windows

Thanks to Sisyphus, Windows users can download and install the ppm version of PDL-Stats and all dependencies using the PPM utility included in ActiveState perl or Strawberry perl. You can also get the PPM utility from CPAN.

ppm install http://www.sisyphusion.tk/ppm/PGPLOT.ppd
ppm install http://www.sisyphusion.tk/ppm/PDL.ppd
ppm install http://www.sisyphusion.tk/ppm/PDL-Stats.ppd


SUPPORT AND DOCUMENTATION
## SUPPORT AND DOCUMENTATION

After installing, you can find documentation for the modules with the
perldoc command.
Expand Down Expand Up @@ -87,8 +98,7 @@ If you notice a bug or have a request, please submit a report at
If you would like to help develop or maintain the package, please email me at the address below.


COPYRIGHT AND LICENCE
~~~~~~~~~~~~ ~~~~~ ~~~~~~~~ ~~~~~ ~~~ `` ><(((">
## COPYRIGHT AND LICENCE

Copyright (C) 2009-2012 Maggie J. Xiong <maggiexyz users.sourceforge.net>

Expand Down

0 comments on commit 08cf4a4

Please sign in to comment.