Implement one-argument cov2cor (#816)

JuliaStats · Jul 26, 2022 · 4220596 · 4220596
1 parent 77590ce
commit 4220596
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/src/cov.jl b/src/cov.jl
@@ -123,13 +123,14 @@ function mean_and_cov(x::DenseMatrix, wv::AbstractWeights, dims::Int=1;
     return m, cov(x, wv, dims; corrected=depcheck(:mean_and_cov, :corrected, corrected))
 end
 
+
 """
-    cov2cor(C, s)
+    cov2cor(C::AbstractMatrix, [s::AbstractArray])
 
-Compute the correlation matrix from the covariance matrix `C` and a vector of standard
-deviations `s`. Use `StatsBase.cov2cor!` for an in-place version.
+Compute the correlation matrix from the covariance matrix `C` and, optionally, a vector
+of standard deviations `s`. Use `StatsBase.cov2cor!` for an in-place version.
 """
-cov2cor(C::AbstractMatrix, s::AbstractArray) = cov2cor!(copy(C), s)
+cov2cor(C::AbstractMatrix, s::AbstractArray=sqrt.(view(C, diagind(C)))) = cov2cor!(copy(C), s)
 
 """
     cor2cov(C, s)

diff --git a/test/cov.jl b/test/cov.jl
@@ -122,6 +122,8 @@ weight_funcs = (weights, aweights, fweights, pweights)
             @testset "cov2cor" begin
                 @test cov2cor(cov(X, dims = 1), std(X, dims = 1)) ≈ cor(X, dims = 1)
                 @test cov2cor(cov(X, dims = 2), std(X, dims = 2)) ≈ cor(X, dims = 2)
+                @test cov2cor(cov1) ≈ cor1
+                @test cov2cor(cov2) ≈ cor2
                 @test cov2cor(cov1, std1) ≈ cor1
                 @test cov2cor(cov2, std2) ≈ cor2
             end