Skip to content

Commit

Permalink
Set up to release CLI (#50)
Browse files Browse the repository at this point in the history
  • Loading branch information
kampersanda authored Oct 26, 2024
1 parent 2bcafe1 commit 60e15ab
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
7 changes: 3 additions & 4 deletions elinor-cli/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,8 @@ authors = ["Shunsuke Kanda (kampersanda) <shnsk.knd@gmail.com>"]
description = "Command line tools for elinor."
license = "MIT OR Apache-2.0"
readme = "README.md"
documentation = "https://docs.rs/elinor"
repository = "https://github.com/kampersanda/elinor"
homepage = "https://github.com/kampersanda/elinor"
keywords = ["information", "retrieval", "evaluation"]
repository = "https://github.com/kampersanda/elinor/tree/main/elinor-cli"
keywords = ["information", "retrieval", "evaluation", "cli"]
categories = ["science"]
rust-version = "1.65.0"

Expand All @@ -22,6 +20,7 @@ prettytable-rs = "0.10.0"
serde_json = "1.0.128"

[dependencies.elinor]
version = "0.3.1"
path = ".."
features = ["serde"]
default-features = false
Expand Down
12 changes: 12 additions & 0 deletions elinor-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,12 @@ The output will be:
+-------------+---------+
```

See the following documentation for more details about the statistical tests:

- [Student's t-test](https://docs.rs/elinor/latest/elinor/statistical_tests/student_t_test/struct.StudentTTest.html)
- [Bootstrap test](https://docs.rs/elinor/latest/elinor/statistical_tests/bootstrap_test/struct.BootstrapTest.html)
- [Fisher's randomized test](https://docs.rs/elinor/latest/elinor/statistical_tests/randomized_tukey_hsd_test/struct.RandomizedTukeyHsdTest.html)

### Example usage: Comparing three systems

If you want to compare the metrics of three (or more) systems, run:
Expand Down Expand Up @@ -267,6 +273,12 @@ The output will be:
(The statistics for the other metrics will be shown as well.)
```

See the following documentation for more details about the statistical tests:

- [Two-way ANOVA without replication](https://docs.rs/elinor/latest/elinor/statistical_tests/two_way_anova_without_replication/struct.TwoWayAnovaWithoutReplication.html)
- [Tukey HSD test](https://docs.rs/elinor/latest/elinor/statistical_tests/tukey_hsd_test/struct.TukeyHsdTest.html)
- [Randomized Tukey HSD test](https://docs.rs/elinor/latest/elinor/statistical_tests/randomized_tukey_hsd_test/struct.RandomizedTukeyHsdTest.html)

### Example usage: Printing the tables in a tab-separated format

If you set `--print-mode raw`, the tables will be printed in a tab-separated format,
Expand Down

0 comments on commit 60e15ab

Please sign in to comment.