-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
18 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,27 @@ | ||
# `pgscatalog-utils` | ||
|
||
This convenience package bundles every PGS Catalog application. | ||
This convenience package bundles every PGS Catalog application, including: | ||
|
||
| Application | Description | Link | | ||
|------------------------------|------------------------------------------------------------------------|-------------------------------------------------------------------------------------| | ||
| `pgscatalog-download` | Download scoring files from the PGS Catalog in specific genome builds | [README](https://pygscatalog.readthedocs.io/en/latest/how-to/guides/download.html) | | ||
| `pgscatalog-combine` | Combine multiple scoring files into a consistent structure | [README](https://pygscatalog.readthedocs.io/en/latest/how-to/guides/combine.html) | | ||
| `pgscatalog-relabel` | Relabel values in a column based on values in a column in another file | [README](pgscatalog.core/README.md) | | ||
| `pgscatalog-match` | Match structured scoring file to variants in target genomes | [README](https://pygscatalog.readthedocs.io/en/latest/how-to/guides/match.html) | | ||
| `pgscatalog-matchmerge` | Merge variant match results, useful on larger datasets | [README](https://pygscatalog.readthedocs.io/en/latest/how-to/guides/match.html) | | ||
| `pgscatalog-aggregate` | Aggregate calculated PGS split across multiple files | [README](https://pygscatalog.readthedocs.io/en/latest/how-to/guides/aggregate.html) | | ||
| `pgscatalog-ancestry-adjust` | Adjust calculated PGS in the context of genetic ancestry | [README](https://pygscatalog.readthedocs.io/en/latest/how-to/guides/ancestry.html) | | ||
|
||
Please note `v1.0.0` contains breaking changes: CLI applications have been renamed and the package has been significantly refactored. | ||
|
||
See https://github.com/PGScatalog/pygscatalog for more details. | ||
|
||
## Installation | ||
|
||
``` | ||
$ pip install pgscatalog-utils | ||
``` | ||
|
||
## Documentation | ||
|
||
Documentation is available at https://pygscatalog.readthedocs.io/. |