diff --git a/readme.md b/readme.md index 31e63bc..71abdb6 100644 --- a/readme.md +++ b/readme.md @@ -1,41 +1,21 @@ # lyagushka -(Russian лягушка: frog) +(Russian лягушка [lʲɪˈɡuʂkə]: frog) -Cluster and Gap Analysis Tool inspired by Fatum Project's 'Zhaba' algorithm (Russian 'жаба': toad) that finds attractor clusters in lists of integers. +Lyagushka is a Rust command-line tool inspired by Fatum Project's 'Zhaba' algorithm (Russian 'жаба': toad) that analyzes a one-dimensional dataset of integers to identify clusters of closely grouped "attractor" points and significant "void" gaps between these clusters. It calculates z-scores for each cluster or gap to measure their statistical significance relative to the dataset's mean density and distance between points. The analysis results, including attractors, voids, and their z-scores, are output as a JSON string. -This Rust command-line tool analyzes a dataset of integers to identify clusters of closely grouped points and significant gaps between these clusters. It calculates z-scores for each cluster or gap to measure their statistical significance relative to the dataset's mean distance. The analysis results, including clusters, gaps, and their z-scores, are output as a JSON string. +## Building -## Features - -- **Cluster Identification**: Identifies groups of points that are closely spaced together based on a customizable threshold. -- **Gap Detection**: Detects significant gaps between clusters, providing insights into the dataset's distribution. -- **Z-Score Calculation**: Calculates z-scores for both clusters and gaps, offering a statistical measure of their deviation from the mean distance. -- **Flexible Input**: Accepts input data either from a file specified as a command-line argument or piped directly into stdin. -- **JSON Output**: Outputs the analysis results in a readable JSON format, making it easy to interpret or use in further processing. +```sh +$ cargo build +``` ## Usage -### From a File - -To analyze a dataset from a file, provide the filename as an argument along with two additional parameters: the factor for adjusting clustering and gap detection thresholds, and the minimum cluster size. - -```sh -cargo run -- filename.txt 0.5 2 -``` - -### From Stdin - -Alternatively, you can pipe a list of integers into the tool, followed by the factor and minimum cluster size. - -```sh -echo "1\n2\n10\n20" | cargo run -- 0.5 2 -``` - -#### Parameters +### Parameters * `filename.txt` (optional): A file containing a newline-separated list of integers to analyze. If not provided, the program expects input from stdin. -* `factor`: A floating-point value used to fine-tune the sensitivity of cluster and gap detection. Lower values result in tighter clusters and wider gaps, while higher values do the opposite. +* `factor`: A floating-point value by which the mean density/span is multiplied to make up a threshold for attractor and void detection. * `min_cluster_size`: An integer specifying the minimum number of contiguous points required to be considered a cluster. ### Output @@ -58,4 +38,21 @@ The tool outputs a JSON string that includes details about the identified cluste "z_score": 2.45 } ] -``` \ No newline at end of file +``` + +### From a File + +To analyze a dataset from a file, provide the filename as an argument, followed by the factor and minimum cluster size parameters +```sh +lyagushka filename.txt 1.5 6 +``` +(= '*Attractor clusters need to have at least 6 numbers with 1.5 times the mean density, void gaps need to be at leat 1.5 times the mean gap size wide*') + +### From Stdin + +Alternatively, you can pipe a list of integers into the tool, followed by the factor and minimum cluster size. + +```sh +echo "1\n2\n10\n20" | lyagushka 0.5 2 +``` +