Skip to content

Commit 2c10aa9

Browse files
author
Montana Flynn
committed
Remove deep links to types and functions
1 parent 11a3adf commit 2c10aa9

File tree

1 file changed

+16
-51
lines changed

1 file changed

+16
-51
lines changed

README.md

Lines changed: 16 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Stats [![][travis-svg]][travis-url] [![][coveralls-svg]][coveralls-url] [![][godoc-svg]][godoc-url] [![][license-svg]][license-url]
22

3-
A statistics package with many functions missing from the Golang standard library.
4-
5-
Currently only `float64` and `[]float64` data is supported due to the lack of generics. However, if the library becomes popular and there is demand I could also add support for the other number types. See the [CHANGELOG.md](https://github.com/montanaflynn/stats/blob/master/CHANGELOG.md) for API changes and tagged releases you can vendor into your projects.
3+
A statistics package with many functions missing from the Golang standard library. See the [CHANGELOG.md](https://github.com/montanaflynn/stats/blob/master/CHANGELOG.md) for API changes and tagged releases you can vendor into your projects.
64

75
> Statistics are used much like a drunk uses a lamppost: for support, not illumination. **- Vin Scully**
86
@@ -16,6 +14,20 @@ go get github.com/montanaflynn/stats
1614

1715
## Usage
1816

17+
The [entire API documentation](http://godoc.org/github.com/montanaflynn/stats) is available on GoDoc.org
18+
19+
You can view docs offline with the following commands:
20+
21+
```
22+
godoc ./
23+
godoc ./ Median
24+
godoc ./ Float64Data
25+
```
26+
27+
**Protip:** Generate HTML docs with `godoc -http=:4444`
28+
29+
## Example
30+
1931
All the functions can be seen in [examples/main.go](https://github.com/montanaflynn/stats/blob/master/examples/main.go) but here's a little taste:
2032

2133
```go
@@ -29,7 +41,7 @@ roundedMedian, _ := stats.Round(median, 0)
2941
fmt.Println(roundedMedian) // 4
3042
```
3143

32-
You can call methods directly on the data ([example](https://github.com/montanaflynn/stats/blob/master/examples/methods.go)) if using the Float64Data type.
44+
**Protip:** You can [call methods](https://github.com/montanaflynn/stats/blob/master/examples/methods.go) on the data if using the Float64Data type:
3345

3446
```
3547
var d stats.Float64Data = data
@@ -38,53 +50,6 @@ max, _ := d.Max()
3850
fmt.Println(max) // 5
3951
```
4052

41-
**Protip:** See all the available methods for Float64Data with `godoc ./ Float64Data`
42-
43-
## Documentation
44-
45-
The [entire API documentation](http://godoc.org/github.com/montanaflynn/stats) is available on GoDoc.org
46-
47-
_Types:_
48-
[`Float64Data`](http://godoc.org/github.com/montanaflynn/stats#Float64Data), [`Series`](http://godoc.org/github.com/montanaflynn/stats#Series), [`Coordinate`](http://godoc.org/github.com/montanaflynn/stats#Coordinate), [`Quartiles`](http://godoc.org/github.com/montanaflynn/stats#Quartiles), [`Outliers`](http://godoc.org/github.com/montanaflynn/stats#Outliers)
49-
50-
_Functions:_
51-
[`Min`](http://godoc.org/github.com/montanaflynn/stats#Min),
52-
[`Max`](http://godoc.org/github.com/montanaflynn/stats#Max),
53-
[`Sum`](http://godoc.org/github.com/montanaflynn/stats#Sum),
54-
[`Mean`](http://godoc.org/github.com/montanaflynn/stats#Mean),
55-
[`Median`](http://godoc.org/github.com/montanaflynn/stats#Median),
56-
[`Mode`](http://godoc.org/github.com/montanaflynn/stats#Mode),
57-
[`Sample`](http://godoc.org/github.com/montanaflynn/stats#Sample),
58-
[`Round`](http://godoc.org/github.com/montanaflynn/stats#Round), [`MedianAbsoluteDeviation`](http://godoc.org/github.com/montanaflynn/stats#MedianAbsoluteDeviation), [`MedianAbsoluteDeviationPopulation`](http://godoc.org/github.com/montanaflynn/stats#MedianAbsoluteDeviationPopulation), [`StandardDeviation`](http://godoc.org/github.com/montanaflynn/stats#StandardDeviation), [`StandardDeviationPopulation`](http://godoc.org/github.com/montanaflynn/stats#StandardDeviationPopulation), [`StandardDeviationSample`](http://godoc.org/github.com/montanaflynn/stats#StandardDeviationSample), [`Percentile`](http://godoc.org/github.com/montanaflynn/stats#Percentile),
59-
[`PercentileNearestRank`](http://godoc.org/github.com/montanaflynn/stats#PercentileNearestRank),
60-
[`LinearRegression`](http://godoc.org/github.com/montanaflynn/stats#LinearRegression),
61-
[`ExponentialRegression`](http://godoc.org/github.com/montanaflynn/stats#ExponentialRegression),
62-
[`LogarithmicRegression`](http://godoc.org/github.com/montanaflynn/stats#LogarithmicRegression),
63-
[`Variance`](http://godoc.org/github.com/montanaflynn/stats#Variance),
64-
[`PopulationVariance`](http://godoc.org/github.com/montanaflynn/stats#PopulationVariance),
65-
[`SampleVariance`](http://godoc.org/github.com/montanaflynn/stats#SampleVariance),
66-
[`Quartile`](http://godoc.org/github.com/montanaflynn/stats#Quartile),
67-
[`InterQuartileRange`](http://godoc.org/github.com/montanaflynn/stats#InterQuartileRange),
68-
[`Midhinge`](http://godoc.org/github.com/montanaflynn/stats#Midhinge),
69-
[`Trimean`](http://godoc.org/github.com/montanaflynn/stats#Trimean),
70-
[`QuartileOutliers`](http://godoc.org/github.com/montanaflynn/stats#QuartileOutliers),
71-
[`GeometricMean`](http://godoc.org/github.com/montanaflynn/stats#GeometricMean),
72-
[`HarmonicMean`](http://godoc.org/github.com/montanaflynn/stats#HarmonicMean),
73-
[`Covariance`](http://godoc.org/github.com/montanaflynn/stats#Covariance),
74-
[`CovariancePopulation`](http://godoc.org/github.com/montanaflynn/stats#CovariancePopulation),
75-
[`Correlation`](http://godoc.org/github.com/montanaflynn/stats#Correlation),
76-
[`LoadRawData`](http://godoc.org/github.com/montanaflynn/stats#LoadRawData)
77-
78-
You can view docs offline with the following commands:
79-
80-
```
81-
godoc ./
82-
godoc ./ Median
83-
godoc ./ Outliers
84-
```
85-
86-
**Protip:** Generate HTML docs with `godoc -http=:4444`
87-
8853
## Contributing
8954

9055
If you have any suggestions, criticism or bug reports please [create an issue](https://github.com/montanaflynn/stats/issues) and I'll do my best to accommodate you. In addition simply starring the repo would show your support for the project and be very much appreciated!

0 commit comments

Comments
 (0)