add readme

README.md

@@ -4,3 +4,15 @@
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://HolyLab.github.io/NMFMerge.jl/dev/)
 [![Build Status](https://github.com/HolyLab/NMFMerge.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/HolyLab/NMFMerge.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/HolyLab/NMFMerge.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/HolyLab/NMFMerge.jl)
+
+This package includes the code the paper ``
+It is used for merging components in non-negative matrix factorization.
+All of the examples below assume you've loaded the package with `using FlyThroughPaths`.
+
+
+## Functions
+
+**colmerge2to1pq**colmerge2to1pq(W, H, n)
+
+This function merges components in ``W`` and ``H`` (columns in ``W`` and rows in ``H``) from original number of components to ``n`` components (``n``columns and rows left in ``W`` and ``H`` respectively) 
+

src/NMF_Merge.jl → src/NMFMerge.jl

@@ -4,7 +4,6 @@ using LinearAlgebra, DataStructures
 
 export colnormalize,
        colmerge2to1pq,
-       mergecol2to1!,
        mergecolumns
 
 function colnormalize(W, H, p::Int=2)

test/runtests.jl

@@ -34,6 +34,7 @@ end
 
     W2 = [W1n[:, j] for j in axes(W1n, 2)];
     H2 = [H1n[i, :] for i in axes(H1n, 1)];
+
     Q1, Q2, _, _, _, _ =build_Qs(W2, H2, 1, 2)
     @test Q1 == Q1'
     @test Q2 == Q2
@@ -51,8 +52,13 @@ end
     @test abs(λ_min - minimum(F.values))<=1e-12
 
     @test abs(u[1]/u[2] - w[1]/w[2])<1e-3*(u[1]/u[2] + w[1]/w[2])/2
-
+    # @show u
+    # @show w
+    # @show u[1]/u[2]
+    # @show w[1]/w[2]
+
     w = [u[1], u[2]]
+    @test norm(w) ≈ 1
     @test norm(Q1*w - maximum(F.values)*Q2*w) < 1e-12
 
     W12, H12, loss = NMFMerge.mergepair(W2, H2, 1, 2)