Skip to content

Commit eeccf94

Browse files
committed
add match cli
1 parent 1de04fd commit eeccf94

File tree

11 files changed

+1360
-40
lines changed

11 files changed

+1360
-40
lines changed

pgscatalog.matchapp/README.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# `pgscatalog-match`
2+
3+
A CLI application that matches (intersects) variants in a normalised scoring file against variant information files. It outputs scoring files compatible with `plink2 --score`, a summary log, and a large match candidate information log.
4+
5+
Various match strategies are used to generate a list of match candidates. These candidates are filtered by user parameters to produce up to one "best match" variant for each variant in the original scoring file.
6+
7+
Matching fails if not enough variants are present in the target variant information files. You can adjust `--min_overlap` to change the matching failure threshold, but it's not a good idea normally.
8+
9+
The [PGS Catalog Calculator](https://github.com/PGScatalog/pgsc_calc) uses this CLI application internally. If you want to calculate polygenic scores using an automated workflow, the PGS Catalog Calculator is the best method to use.
10+
11+
## Installation
12+
13+
```
14+
$ pip install pgscatalog-match
15+
```
16+
17+
## Usage
18+
19+
```
20+
$ pgscatalog-match ...
21+
```
22+
23+
## Documentation
24+
25+
See **link to docs**.
26+
27+
## Help
28+
29+
```
30+
$ pgscatalog-match --help
31+
```

pgscatalog.matchapp/poetry.lock

+637
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pgscatalog.matchapp/poetry.toml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[virtualenvs]
2+
create = true
3+
in-project = true

pgscatalog.matchapp/pyproject.toml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
[tool.poetry]
2+
name = "pgscatalog-matchapp"
3+
version = "0.1.0"
4+
description = ""
5+
authors = ["Benjamin Wingfield <bwingfield@ebi.ac.uk>"]
6+
license = "Apache-2.0"
7+
readme = "README.md"
8+
packages = [
9+
{ include = "pgscatalog", from = "src" },
10+
]
11+
12+
13+
[tool.poetry.dependencies]
14+
python = "^3.11"
15+
"pgscatalog.matchlib" = {path = "../pgscatalog.matchlib", develop = true}
16+
17+
18+
[tool.poetry.group.dev.dependencies]
19+
pytest = "^8.0.0"
20+
21+
[build-system]
22+
requires = ["poetry-core"]
23+
build-backend = "poetry.core.masonry.api"

pgscatalog.matchapp/src/pgscatalog/matchapp/combine_cli.py

Whitespace-only changes.

0 commit comments

Comments
 (0)