# CIDC NGS Pipeline API
### Overview
This repository serves as an interface between the CIDC and Bioinformatics teams to determine specifications and documentation related to NGS pipelines.
Repository structure:
```
.
├── README.md
├── cidc_ngs_pipeline_api
│ ├── output_API.schema.json
│ ├── rna
│ │ ├── rna.md => ../../docs/rna.md
│ │ ├── rna_config.schema.json
│ │ ├── rna_output_API.json
│ │ └── imgs
│ | └── RIMA.png
│ ├── atacseq
│ │ ├── atacseq.md => ../../docs/atacseq.md
│ │ ├── atacseq_output_API.json
│ │ └── imgs
│ | └── atacseq.png
│ ├── tcr
│ │ ├── tcr.md => ../../docs/tcr.md
│ │ └── imgs
│ | └── TCRseq.png
│ └── wes
│ ├── wes.md => ../../docs/wes.md
│ ├── wes_config.schema.json
│ ├── wes_output_API.json
│ ├── wes_tumor_only_output_API.json
│ ├── wes_output_API.py
│ └── imgs
│ └── wes.png
├── tests
│ └── test_apis.py
├── requirements.dev.txt
├── requirements.txt
├── MANIFEST.in
├── CHANGELOG.md
├── setup.py
└── .github
└── workflows
└── ci.yml
```
## cidc_ngs_pipeline_api module
* The `output_API.schema.json` file defines the schema structure:
- `filter_group`: Filter under which the file would appear during faceted search. It is the GCS-URI top-level hierarchy
- `file_path_template`: Local file path used for CLI upload
- `short_description`: Description to appear on hovering over file name in file browser
- `long_description`: Longer description to appear on file documentation page
- `file_purpose`: Assigns a tag to show up in a particular file-browser view configuration. Permissible values: `Source view`, `Analysis view`, `Clinical view`, `Miscellaneous`
* Within the directory for each assay:
* The defined schema is used to structure information about pipeline-related files in the respective `< assay >_output_API.json`.
* Information related to YAML configurations (which are generated by the CIDC and configured with CIMAC IDs to run the pipelines), are described in the respective `< assay > config.schema.json`.
* Documentation related to each pipeline is in the respective `< assay > .md`.
### Developer Setup
Install necessary dependencies.
```bash
pip install -r requirements.dev.txt
```
Install and configure pre-commit hooks.
```bash
pre-commit install
```
Raw data
{
"_id": null,
"home_page": "https://github.com/NCI-CIDC/cidc-ngs-pipeline-api",
"name": "nci-cidc-ngs-pipeline-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "cidc_ngs_pipeline_api",
"author": "NCI",
"author_email": "nci-cidc-tools-admin@mail.nih.gov",
"download_url": "https://files.pythonhosted.org/packages/28/a3/a2080d07468132850e2cbc5cb4733c383ce448323a5b0df45facbdb35b37/nci_cidc_ngs_pipeline_api-0.1.26.tar.gz",
"platform": null,
"description": "# CIDC NGS Pipeline API\n\n### Overview\nThis repository serves as an interface between the CIDC and Bioinformatics teams to determine specifications and documentation related to NGS pipelines.\n\nRepository structure:\n```\n.\n\u251c\u2500\u2500 README.md\n\u251c\u2500\u2500 cidc_ngs_pipeline_api\n\u2502 \u251c\u2500\u2500 output_API.schema.json\n\u2502 \u251c\u2500\u2500 rna\n\u2502 \u2502\u00a0\u00a0 \u251c\u2500\u2500 rna.md => ../../docs/rna.md\n\u2502 \u2502\u00a0\u00a0 \u251c\u2500\u2500 rna_config.schema.json\n\u2502 \u2502\u00a0\u00a0 \u251c\u2500\u2500 rna_output_API.json\n\u2502 \u2502\u00a0\u00a0 \u2514\u2500\u2500 imgs\n\u2502 | \u2514\u2500\u2500 RIMA.png\n\u2502 \u251c\u2500\u2500 atacseq\n\u2502 \u2502\u00a0\u00a0 \u251c\u2500\u2500 atacseq.md => ../../docs/atacseq.md\n\u2502 \u2502\u00a0\u00a0 \u251c\u2500\u2500 atacseq_output_API.json\n\u2502 \u2502\u00a0\u00a0 \u2514\u2500\u2500 imgs\n\u2502 | \u2514\u2500\u2500 atacseq.png\n\u2502 \u251c\u2500\u2500 tcr\n\u2502 \u2502\u00a0\u00a0 \u251c\u2500\u2500 tcr.md => ../../docs/tcr.md\n\u2502 \u2502\u00a0\u00a0 \u2514\u2500\u2500 imgs\n\u2502 | \u2514\u2500\u2500 TCRseq.png\n\u2502 \u2514\u2500\u2500 wes\n\u2502 \u251c\u2500\u2500 wes.md => ../../docs/wes.md\n\u2502 \u251c\u2500\u2500 wes_config.schema.json\n\u2502 \u251c\u2500\u2500 wes_output_API.json\n\u2502 \u251c\u2500\u2500 wes_tumor_only_output_API.json\n\u2502 \u251c\u2500\u2500 wes_output_API.py\n\u2502 \u00a0 \u2514\u2500\u2500 imgs\n\u2502 \u2514\u2500\u2500 wes.png\n\u251c\u2500\u2500 tests\n\u2502 \u2514\u2500\u2500 test_apis.py\n\u251c\u2500\u2500 requirements.dev.txt\n\u251c\u2500\u2500 requirements.txt\n\u251c\u2500\u2500 MANIFEST.in\n\u251c\u2500\u2500 CHANGELOG.md\n\u251c\u2500\u2500 setup.py\n\u2514\u2500\u2500 .github\n \u2514\u2500\u2500 workflows\n \u2514\u2500\u2500 ci.yml\n \n```\n\n## cidc_ngs_pipeline_api module\n\n* The `output_API.schema.json` file defines the schema structure:\n - `filter_group`: Filter under which the file would appear during faceted search. It is the GCS-URI top-level hierarchy\n - `file_path_template`: Local file path used for CLI upload\n - `short_description`: Description to appear on hovering over file name in file browser\n - `long_description`: Longer description to appear on file documentation page\n - `file_purpose`: Assigns a tag to show up in a particular file-browser view configuration. Permissible values: `Source view`, `Analysis view`, `Clinical view`, `Miscellaneous`\n \n* Within the directory for each assay:\n \n * The defined schema is used to structure information about pipeline-related files in the respective `< assay >_output_API.json`.\n\n * Information related to YAML configurations (which are generated by the CIDC and configured with CIMAC IDs to run the pipelines), are described in the respective `< assay > config.schema.json`.\n\n * Documentation related to each pipeline is in the respective `< assay > .md`.\n\n### Developer Setup\n\nInstall necessary dependencies.\n\n```bash\npip install -r requirements.dev.txt\n```\n\nInstall and configure pre-commit hooks.\n\n```bash\npre-commit install\n```\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "The NCI CIDC NGS Pipeline output APIs",
"version": "0.1.26",
"project_urls": {
"Homepage": "https://github.com/NCI-CIDC/cidc-ngs-pipeline-api"
},
"split_keywords": [
"cidc_ngs_pipeline_api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "00a33bd1dfab3ce001032b22fb001205921367fb1e283bf9dceb24d2224353f9",
"md5": "8f3490a815edbcd130699cabcdaea04f",
"sha256": "0451560e19e972fbf63d73a8a10653deb2152085c765639c27f0a404288c4e0b"
},
"downloads": -1,
"filename": "nci_cidc_ngs_pipeline_api-0.1.26-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f3490a815edbcd130699cabcdaea04f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 2343267,
"upload_time": "2024-01-22T18:02:24",
"upload_time_iso_8601": "2024-01-22T18:02:24.694370Z",
"url": "https://files.pythonhosted.org/packages/00/a3/3bd1dfab3ce001032b22fb001205921367fb1e283bf9dceb24d2224353f9/nci_cidc_ngs_pipeline_api-0.1.26-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "28a3a2080d07468132850e2cbc5cb4733c383ce448323a5b0df45facbdb35b37",
"md5": "b6cea7c7109b73700ca49f1db7f22456",
"sha256": "ede18decaf2aca9d089f9ad9ccef66107ddd2d424394e4b651bc00e0ea87eb8b"
},
"downloads": -1,
"filename": "nci_cidc_ngs_pipeline_api-0.1.26.tar.gz",
"has_sig": false,
"md5_digest": "b6cea7c7109b73700ca49f1db7f22456",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 2343157,
"upload_time": "2024-01-22T18:02:27",
"upload_time_iso_8601": "2024-01-22T18:02:27.189100Z",
"url": "https://files.pythonhosted.org/packages/28/a3/a2080d07468132850e2cbc5cb4733c383ce448323a5b0df45facbdb35b37/nci_cidc_ngs_pipeline_api-0.1.26.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-22 18:02:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NCI-CIDC",
"github_project": "cidc-ngs-pipeline-api",
"github_not_found": true,
"lcname": "nci-cidc-ngs-pipeline-api"
}
JSON
