From afe88356c67ebccebf713620fd2656c2c1baa08f Mon Sep 17 00:00:00 2001 From: Abhinav Natarajan Date: Mon, 6 Feb 2023 15:15:17 +0000 Subject: [PATCH] update readme and docs, bump to v1.2.0 --- Project.toml | 2 +- README.md | 4 ++-- docs/src/index.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Project.toml b/Project.toml index ce87039..c903d66 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "RedClust" uuid = "bf1adee6-87fe-4679-8d23-51fe99940a25" authors = ["Abhinav Natarajan "] -version = "1.2.0beta2" +version = "1.2.0" [deps] Clustering = "aaaa29a8-35af-508c-8bc3-b662a17a0fe5" diff --git a/README.md b/README.md index 10853cc..255760f 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ pointestimate, index = getpointestimate(result) # Summary of point estimate summarise(pointestimate, clusts) ``` -A more elaborate example can be found in the detailed documentation. +A more elaborate example can be found in the detailed documentation. Examples from the paper and its supplementary material can be found in the ['examples' branch of this repository](https://github.com/abhinavnatarajan/RedClust.jl/tree/examples). ## Citing this package If you want to use this package in your work, please cite it as: @@ -64,7 +64,7 @@ For BibTeX users: } ``` -[github-CI-img]: https://img.shields.io/github/workflow/status/abhinavnatarajan/RedClust.jl/CI?label=CI&logo=github&labelColor=222222 +[github-CI-img]: https://img.shields.io/github/workflow/status/abhinavnatarajan/RedClust.jl/CI.yml?label=CI&logo=github&labelColor=222222 [github-CI-url]: https://github.com/abhinavnatarajan/RedClust.jl/actions/workflows/CI.yml [codecov-img]: https://img.shields.io/codecov/c/github/abhinavnatarajan/RedClust.jl?logo=codecov&labelColor=222222&logoColor=white diff --git a/docs/src/index.md b/docs/src/index.md index 62b58bb..13594ea 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -32,7 +32,7 @@ pointestimate, index = getpointestimate(result) summarise(result) summarise(pointestimate, clusts) ``` -A more elaborate example can be found in the [Example](@ref) section. +A more elaborate example can be found in the [Example](@ref) section. Examples from the paper and its supplementary material can be found in the ['examples' branch](https://github.com/abhinavnatarajan/RedClust.jl/tree/examples) of the [Github repository for RedClust.jl](https://github.com/abhinavnatarajan/RedClust.jl). ## Model RedClust implements the model described in Natarajan et al. (2022). The key features are-