Metadata-Version: 2.4
Name: PheQTK
Version: 0.0.4
Summary: A wrapper to the PheTK package.
Author-email: Marjorie Kohn <marjoriekohn@icloud.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/marjoriekohn/PheQTK
Project-URL: Issues, https://github.com/marjoriekohn/PheQTK/issues
Project-URL: PheTK, https://github.com/nhgritctran/PheTK
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PheTK==0.1.47
Dynamic: license-file

# PheQTK - The Phenotype Quick Toolkit
PheQTK is a Python package that wraps around [PheTK](https://github.com/nhgritctran/PheTK). 

## Installation
In your All of Us jupyter notebook, install PheQTK using the following command:

```bash
!pip install --upgrade PheQTK 
```

## Usage
To start the PheQTK interface, run the following command:

```python
from PheQTK import Quick

Quick.run()
```
You will be prompted to select a module. You can also select 'all' to run all modules.

If you run individual modules, you will be prompted to add required parameters for that module. Below is a list of the required parameters for each module:
- Cohort Module:
  - a comma separated list of variant ids (20_13093478_G_A, 20_13093479_G_A, etc.)
- Phecodes Module:
  - 

## Roadmap
Currently, PheQTK only supports PheTK's Cohort Module. Additional modules will be added soon.

## Contributing
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.

## License
[MIT](https://choosealicense.com/licenses/mit/)
