Skip to content

Commit

Permalink
Fix Jaccard docs
Browse files Browse the repository at this point in the history
  • Loading branch information
richardreeve committed Nov 10, 2023
1 parent 3801b38 commit d705ff5
Showing 1 changed file with 13 additions and 17 deletions.
30 changes: 13 additions & 17 deletions docs/src/ecology.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,23 +38,19 @@ julia> jaccard(ecosystem)
─────┼─────────────────────────────────────────────────────────────────────────────────────────────
1 │ Unique Jaccard 0 types metacommunity 0.333333
julia> generalisedjaccard(ecosystem, [0, 1, 2])
3×8 DataFrame
Row │ div_type measure q type_level type_name partition_level partition_name diversity
│ String String Int64 String String String String Float64
─────┼────────────────────────────────────────────────────────────────────────────────────────────────
1 │ Arbitrary Z Jaccard 0 types metacommunity 0.333333
2 │ Arbitrary Z Jaccard 1 types metacommunity 0.414214
3 │ Arbitrary Z Jaccard 2 types metacommunity 0.5
julia> generalisedjaccard(ecosystem, [0, 1, 2], Matrix(1.0I, 3, 3))
3×8 DataFrame
Row │ div_type measure q type_level type_name partition_level partition_name diversity
│ String String Int64 String String String String Float64
─────┼────────────────────────────────────────────────────────────────────────────────────────────────
1 │ Arbitrary Z Jaccard 0 types metacommunity 0.333333
2 │ Arbitrary Z Jaccard 1 types metacommunity 0.414214
3 │ Arbitrary Z Jaccard 2 types metacommunity 0.5
julia> generalisedjaccard(Metacommunity(ecosystem))
1×7 DataFrame
Row │ div_type measure type_level type_name partition_level partition_name diversity
│ String String String String String String Float64
─────┼──────────────────────────────────────────────────────────────────────────────────────
1 │ Unique Jaccard types metacommunity 0.333333
julia> generalisedjaccard(ecosystem, Matrix(1.0I, 3, 3))
1×7 DataFrame
Row │ div_type measure type_level type_name partition_level partition_name diversity
│ String String String String String String Float64
─────┼─────────────────────────────────────────────────────────────────────────────────────────
1 │ Arbitrary Z Jaccard types metacommunity 0.333333
julia> community = [0.7, 0.2, 0.1];
Expand Down

2 comments on commit d705ff5

@richardreeve
Copy link
Member 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/95098

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

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 v0.5.9 -m "<description of version>" d705ff59daa5669d3e181e5dc3d3f840cda9acc7
git push origin v0.5.9

Please sign in to comment.