# pheno-utils
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
pheno-utils is a dynamic Python package developed by Pheno.AI, for
handling our medical datasets. It simplifies data loading, enables
effective merging, and offers intuitive visualization tools.
## Install
``` sh
pip install pheno_utils
```
## How to use
Examples:
``` python
data = generate_synthetic_data(n=1000)
hist_ecdf_plots(data=data, col="val1")
```

``` python
age_refplots = GenderAgeRefPlot(data, "val1")
age_refplots.plot()
```

## Setting Up pheno-utils
To use `pheno-utils`, you must have a `config.json` file. This file
should be set up according to your filesystem and placed in the
`~/.pheno/` directory.
### If You’re Working on TRE
For those working in the Trusted Research Environment (TRE), you don’t
need to worry about the `config.json` file. It will be automatically
generated for you!
### If You’re Working with Phenos’ S3 Bucket
If you’re working with Phenos’ S3 bucket, you’ll need to manually create
the `config.json` file. You can do this by running the following Python
script:
``` sh
python config_setup/create_default_config.py -d s3://datasets_bucket_name
```
### If you are working on local file system
If you are working on local file system, you’ll need to manually create
the `config.json` file and locating it under `~/.pheno/` directory.
Please use the config_setup/example_config.json as a template for your
config.json file.
Raw data
{
"_id": null,
"home_page": "https://github.com/pheno-ai/pheno-utils",
"name": "pheno-utils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "nbdev jupyter notebook python",
"author": "pheno.ai",
"author_email": "hagai@pheno.ai",
"download_url": "https://files.pythonhosted.org/packages/7b/06/cfbc77fe02906e5076b4c08c111182f75beaf05da10c32ed9273faebc009/pheno-utils-0.4.0.tar.gz",
"platform": null,
"description": "# pheno-utils\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\npheno-utils is a dynamic Python package developed by Pheno.AI, for\nhandling our medical datasets. It simplifies data loading, enables\neffective merging, and offers intuitive visualization tools.\n\n## Install\n\n``` sh\npip install pheno_utils\n```\n\n## How to use\n\nExamples:\n\n``` python\ndata = generate_synthetic_data(n=1000)\nhist_ecdf_plots(data=data, col=\"val1\")\n```\n\n\n\n``` python\nage_refplots = GenderAgeRefPlot(data, \"val1\")\nage_refplots.plot()\n```\n\n\n\n## Setting Up pheno-utils\n\nTo use `pheno-utils`, you must have a `config.json` file. This file\nshould be set up according to your filesystem and placed in the\n`~/.pheno/` directory.\n\n### If You\u2019re Working on TRE\n\nFor those working in the Trusted Research Environment (TRE), you don\u2019t\nneed to worry about the `config.json` file. It will be automatically\ngenerated for you!\n\n### If You\u2019re Working with Phenos\u2019 S3 Bucket\n\nIf you\u2019re working with Phenos\u2019 S3 bucket, you\u2019ll need to manually create\nthe `config.json` file. You can do this by running the following Python\nscript:\n\n``` sh\npython config_setup/create_default_config.py -d s3://datasets_bucket_name\n```\n\n### If you are working on local file system\n\nIf you are working on local file system, you\u2019ll need to manually create\nthe `config.json` file and locating it under `~/.pheno/` directory.\nPlease use the config_setup/example_config.json as a template for your\nconfig.json file.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Pheno data utils - viz, loaders, mergers",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/pheno-ai/pheno-utils"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5700e7867421e0177c3cc72beacd17ee2d7c601d79133fdd17f09ba4c01c6b9b",
"md5": "9a740f732c0a6c20e80c0dca1b4e234f",
"sha256": "afb6a7ea121e5305cc3bd068f0a998c57994c9f81d58335397fe25723952489a"
},
"downloads": -1,
"filename": "pheno_utils-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a740f732c0a6c20e80c0dca1b4e234f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 52510,
"upload_time": "2024-09-09T12:02:46",
"upload_time_iso_8601": "2024-09-09T12:02:46.662294Z",
"url": "https://files.pythonhosted.org/packages/57/00/e7867421e0177c3cc72beacd17ee2d7c601d79133fdd17f09ba4c01c6b9b/pheno_utils-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7b06cfbc77fe02906e5076b4c08c111182f75beaf05da10c32ed9273faebc009",
"md5": "7f67ec39b5a85ff44bb22f7a3798eb55",
"sha256": "be7a9c606cf7ded56611aed44dfee2f078a1c6794452016ff2e9acd658c8fb39"
},
"downloads": -1,
"filename": "pheno-utils-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "7f67ec39b5a85ff44bb22f7a3798eb55",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 45753,
"upload_time": "2024-09-09T12:02:47",
"upload_time_iso_8601": "2024-09-09T12:02:47.899098Z",
"url": "https://files.pythonhosted.org/packages/7b/06/cfbc77fe02906e5076b4c08c111182f75beaf05da10c32ed9273faebc009/pheno-utils-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-09 12:02:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pheno-ai",
"github_project": "pheno-utils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pheno-utils"
}