You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs-site/docs/what-is-pheno-ranker.mdx
+13-4Lines changed: 13 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,22 @@ slug: "/what-is-pheno-ranker"
4
4
---
5
5
# What is Pheno-Ranker?
6
6
7
-
`Pheno-Ranker` is a command-line tool for _individual-level_ comparison of phenotypic, clinical, and other categorical records. It was designed for GA4GH-oriented data such as [Beacon v2](/bff) and [Phenopackets v2](/pxf), but it can also compare generic `JSON`, `YAML`, and `CSV`-derived datasets.
7
+
`Pheno-Ranker` is a command-line tool for **individual-level comparison** of phenotypic, clinical, and other categorical records. It was designed for GA4GH-oriented data such as [Beacon v2](/bff) and [Phenopackets v2](/pxf), but it can also compare generic `JSON`, `YAML`, and `CSV`-derived datasets.
8
8
9
-
The primary interface is the `pheno-ranker` CLI. This makes it straightforward to use from a terminal, shell scripts, R/Python automation, workflow managers, and reproducible batch analyses. A Web App UI is also available for interactive use.
9
+
The primary interface is the `pheno-ranker` CLI. This makes it straightforward to use from a terminal, shell scripts, R/Python automation, workflow managers, and **reproducible batch analyses**. A Web App UI is also available for interactive use.
10
10
11
-
The central idea is simple: hierarchical records are flattened, transformed into one-hot encoded binary vectors, and compared with metrics such as [Hamming distance](https://en.wikipedia.org/wiki/Hamming_distance) and [Jaccard similarity](https://en.wikipedia.org/wiki/Jaccard_index). This makes the same command-line workflow useful for cohort exploration, patient matching, clustering, multidimensional scaling, and graph analytics.
11
+
:::tip[Designed for scale]
12
+
`Pheno-Ranker` is intended for analyses that are too large to inspect manually: **thousands of records** in all-vs-all cohort comparisons, and **hundreds of thousands to millions of reference records** in patient mode when the feature space, hardware, and output choices permit it.
13
+
:::
14
+
15
+
The central idea is simple:
16
+
17
+
1. Hierarchical records are **flattened** into comparable variables.
18
+
2. Variables are transformed into **one-hot encoded binary vectors**.
19
+
3. Vectors are compared with metrics such as [Hamming distance](https://en.wikipedia.org/wiki/Hamming_distance) and [Jaccard similarity](https://en.wikipedia.org/wiki/Jaccard_index).
20
+
4. Results can be used for **cohort exploration**, **patient matching**, clustering, multidimensional scaling, and graph analytics.
12
21
13
-
`Pheno-Ranker` is designed to be lightweight and fast for practical cohort analyses. The CLI workflow avoids database setup, uses compact binary representations internally, and can write sparse Matrix Market output for large all-vs-all comparisons when a dense matrix is unnecessary.
22
+
`Pheno-Ranker` is designed to be lightweight and fast for practical cohort analyses. The CLI workflow **avoids database setup**, uses compact binary representations internally, and can write sparse Matrix Market output for large all-vs-all comparisons when a dense matrix is unnecessary.
0 commit comments