README.md in distribution-0.7.1 vs README.md in distribution-0.7.2
- old
+ new
@@ -1,61 +1,66 @@
-# [Distribution](https://github.com/clbustos/distribution) Quick Start
+# [Distribution](https://github.com/sciruby/distribution)
+[![Build Status](https://travis-ci.org/SciRuby/distribution.svg?branch=master)](https://travis-ci.org/SciRuby/distribution)
+[![Code Climate](https://codeclimate.com/github/SciRuby/distribution/badges/gpa.svg)](https://codeclimate.com/github/SciRuby/distribution)
+
+## Installation
+
```
-git clone https://github.com/sciruby/distribution
+$ gem install distribution
```
-## Description:
+If you have GSL installed and want to speed things up, install `rb-gsl`:
+```bash
+$ gem install rb-gsl
+```
+
+## Description
+
Statistical Distributions library. Includes Normal univariate and bivariate, T, F, Chi Square, Binomial, Hypergeometric, Exponential, Poisson, Beta, LogNormal and Gamma.
Uses Ruby by default and C (statistics2/GSL) or Java extensions where available.
Includes code from statistics2 on Normal, T, F and Chi Square ruby code [http://blade.nagaokaut.ac.jp/~sinara/ruby/math/statistics2]
-## Synopsis:
- * Returns Gaussian PDF for x
- pdf=Distribution::Normal.pdf(x)
- * Returns Gaussian CDF for x
- cdf=Distribution::Normal.cdf(x)
- * Returns inverse CDF (or p-value) for x
- pv=Distribution::Normal.p_value(x)
+## Synopsis
-## System Requirements:
+* Returns Gaussian PDF for x
-To increase (notably!) the speed, please install
+```
+pdf=Distribution::Normal.pdf(x)
+```
-* Ruby 1.8-1.9: gsl (prefered) or statistics2
-* Java: Not yet implemented
+* Returns Gaussian CDF for x
-## User Installation:
```
- gem install distribution
+cdf=Distribution::Normal.cdf(x)
```
-To speep up
+
+* Returns inverse CDF (or p-value) for x
+
```
- gem install gsl
- gem install statistics
+pv=Distribution::Normal.p_value(x)
```
-## Developers:
+## Developers
-After checking out the source, run:
```
- $ rake newb
+$ git clone https://github.com/SciRuby/distribution.git
```
-This task will install any missing dependencies, run the tests/specs,
-and generate the RDoc.
-If you want to provide a new distribution, /lib/distribution run
+If you want to provide a new distribution, run `lib/distribution`:
+
```
- $ distribution --new your_distribution
+$ distribution --new your_distribution
```
-This should create the main distribution file, the directory with ruby and gsl engines and the rspec on /spec directory.
-### API Structure
+This should create the main distribution file, the directory with Ruby and GSL engines and specs on the spec/ directory.
+## API Structure
+
Distribution::<name>.(cdf|pdf|p_value|rng)
On discrete distributions, exact Ruby implementations of pdf, cdf and p_value could be provided, using
```
Distribution::<name>.exact_(cdf|pdf|p_value)
@@ -86,11 +91,13 @@
### API Structure Example
```
Distribution::T.cdf
```
+
could be called after including Distribution::Shorthand
+
```
tdist_cdf
```
## Features
@@ -98,8 +105,8 @@
* Very fast ruby 1.8.7/1.9.+ implementation, with improved method to calculate factorials and others common functions
* All methods tested on several ranges. See spec/
## Issues
-* On Jruby and Rubinius, BivariateNormal returns incorrect pdf
+* On JRuby and Rubinius, BivariateNormal returns incorrect pdf
-For current issues see the [issue tracker pages](https://github.com/clbustos/distribution/issues)
+For current issues see the [issue tracker pages](https://github.com/sciruby/distribution/issues).