# 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")
```
![](index_files/figure-commonmark/cell-2-output-1.png)
``` python
age_refplots = GenderAgeRefPlot(data, "val1")
age_refplots.plot()
```
![](index_files/figure-commonmark/cell-3-output-1.png)
## 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": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python",
"author": "pheno.ai",
"author_email": "hagai@pheno.ai",
"download_url": "https://files.pythonhosted.org/packages/08/0c/5f4cf104b03d5da1ca801404eea3c7052212432cff2a5ccf18a2d255e092/pheno-utils-0.3.9.1.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![](index_files/figure-commonmark/cell-2-output-1.png)\n\n``` python\nage_refplots = GenderAgeRefPlot(data, \"val1\")\nage_refplots.plot()\n```\n\n![](index_files/figure-commonmark/cell-3-output-1.png)\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.3.9.1",
"project_urls": {
"Homepage": "https://github.com/pheno-ai/pheno-utils"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4d8b470b5db6583f1f499e2883050566ba64af114883c9f70ede6bb10c348e3e",
"md5": "328e49a50bbacf0b7afabea02ce021d8",
"sha256": "9e10361abce7e7013b984f73af96a96d3bda032735f922168ae6a25bd4eb3aa0"
},
"downloads": -1,
"filename": "pheno_utils-0.3.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "328e49a50bbacf0b7afabea02ce021d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 44389,
"upload_time": "2023-11-23T14:35:11",
"upload_time_iso_8601": "2023-11-23T14:35:11.161365Z",
"url": "https://files.pythonhosted.org/packages/4d/8b/470b5db6583f1f499e2883050566ba64af114883c9f70ede6bb10c348e3e/pheno_utils-0.3.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "080c5f4cf104b03d5da1ca801404eea3c7052212432cff2a5ccf18a2d255e092",
"md5": "1fa3d844e4f66f92044ac8c97ae29f4b",
"sha256": "21187a8d812b5b8cd3c0d70fae61b978eb3e32d159b319f177b2642598eddd90"
},
"downloads": -1,
"filename": "pheno-utils-0.3.9.1.tar.gz",
"has_sig": false,
"md5_digest": "1fa3d844e4f66f92044ac8c97ae29f4b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 37848,
"upload_time": "2023-11-23T14:35:13",
"upload_time_iso_8601": "2023-11-23T14:35:13.849807Z",
"url": "https://files.pythonhosted.org/packages/08/0c/5f4cf104b03d5da1ca801404eea3c7052212432cff2a5ccf18a2d255e092/pheno-utils-0.3.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-23 14:35:13",
"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"
}