Skip to content

Commit

Permalink
update readme and docs, bump to v1.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@abhinavnatarajan
abhinavnatarajan committed Feb 6, 2023
1 parent d39065e commit afe8835
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "RedClust"
uuid = "bf1adee6-87fe-4679-8d23-51fe99940a25"
authors = ["Abhinav Natarajan <[email protected]>"]
version = "1.2.0beta2"
version = "1.2.0"

[deps]
Clustering = "aaaa29a8-35af-508c-8bc3-b662a17a0fe5"
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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-
Expand Down

4 comments on commit afe8835

@abhinavnatarajan
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/77132

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.2.0 -m "<description of version>" afe88356c67ebccebf713620fd2656c2c1baa08f
git push origin v1.2.0

Also, note the warning: Version 1.2.0 skips over 1.1.0
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

@abhinavnatarajan
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/77132

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.2.0 -m "<description of version>" afe88356c67ebccebf713620fd2656c2c1baa08f
git push origin v1.2.0

Please sign in to comment.