Merge StatsBase into Statistics

Author: nalimilan

.github/workflows/ci.yml

@@ -40,10 +40,7 @@ jobs:
             ${{ runner.os }}-test-${{ env.cache-name }}-
             ${{ runner.os }}-test-
             ${{ runner.os }}-
-<<<<<<< HEAD
-=======
       - run: julia --color=yes .ci/test_and_change_uuid.jl
->>>>>>> master
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1
@@ -55,20 +52,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-<<<<<<< HEAD
       - uses: julia-actions/julia-buildpkg@latest
       - uses: julia-actions/julia-docdeploy@latest
-=======
-      - uses: julia-actions/setup-julia@v1
-        with:
-          version: '1'
-      - run: |
-          julia --project=docs -e '
-            using Pkg
-            Pkg.develop(PackageSpec(path=pwd()))
-            Pkg.instantiate()'
-      - run: julia --project=docs docs/make.jl
->>>>>>> master
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

Project.toml

@@ -3,11 +3,13 @@ uuid = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 
 [extras]
+Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Random", "Test"]
+test = ["Dates", "Random", "Test"]

docs/Project.toml

@@ -2,4 +2,4 @@
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 
 [compat]
-Documenter = "0.24"
+Documenter = "0.27"

docs/make.jl

@@ -1,16 +1,22 @@
-using Documenter, Statistics
+using Documenter, Statistics, Random
 
 # Workaround for JuliaLang/julia/pull/28625
 if Base.HOME_PROJECT[] !== nothing
     Base.HOME_PROJECT[] = abspath(Base.HOME_PROJECT[])
 end
 
 makedocs(
+    sitename = "Statistics.jl",
     modules = [Statistics],
-    sitename = "Statistics",
-    pages = Any[
-        "Statistics" => "index.md"
-        ]
-    )
+    pages = ["index.md",
+             "weights.md",
+             "scalarstats.md",
+             "cov.md",
+             "robust.md",
+             "ranking.md",
+             "empirical.md"]
+)
 
-deploydocs(repo = "github.com/JuliaLang/Statistics.jl.git")
+deploydocs(
+    repo = "github.com/JuliaLang/Statistics.jl.git"
+)

docs/src/counts.md

@@ -1,17 +1,46 @@
-# Scatter Matrix and Covariance
+# Covariances and Correlations
 
-This package implements functions for computing scatter matrix, as well as weighted covariance matrix.
+Functions to computing various types of covariances and correlations are provided.
+
+## Covariance, Correlation and Scatter Matrix
 
 ```@docs
-scattermat
 cov
-cov(::CovarianceEstimator, ::AbstractVector)
-cov(::CovarianceEstimator, ::AbstractVector, ::AbstractVector)
-cov(::CovarianceEstimator, ::AbstractMatrix)
 cor
-mean_and_cov
+scattermat
 cov2cor
 cor2cov
 CovarianceEstimator
 SimpleCovariance
 ```
+
+## Partial Correlation
+
+```@docs
+partialcor
+```
+
+## Autocovariance and Autocorrelation
+
+```@docs
+autocov
+autocov!
+autocor
+autocor!
+```
+
+## Cross-covariance and Cross-correlation
+
+```@docs
+crosscov
+crosscov!
+crosscor
+crosscor!
+```
+
+## Partial Autocorrelation Function
+
+```@docs
+pacf
+pacf!
+```

docs/src/cov.md

@@ -1,4 +1,4 @@
-# Empirical Estimation
+# Empirical Estimation of Distributions
 
 ## Histograms
 
@@ -16,6 +16,7 @@ Additional methods
 ```@docs
 merge!
 merge
+midpoints
 norm
 normalize
 normalize!

docs/src/deviation.md

@@ -1,19 +1,16 @@
 # Statistics
 
-The Statistics standard library module contains basic statistics functionality.
+```@meta
+DocTestSetup = :(using Statistics)
+```
+
+The Statistics module contains basic statistics functionality: mean, median, quantiles,
+standard deviation, variance, skewness, kurtosis, correlation and covariance.
+Statistics can be weighted, and several weights types are distinguished to apply appropriate
+corrections where necessary.
 
-```@docs
-std
-stdm
-var
-varm
-cor
-cov
-mean!
-mean
-median!
-median
-middle
-quantile!
-quantile
+```@contents
+Pages = ["weights.md", "scalarstats.md", "cov.md", "robust.md", "ranking.jl",
+         "empirical.md"]
+Depth = 2
 ```