https://github.com/clinical-genomics/chanjo2
Persistent coverage analysis tool using the d4 format
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: nature.com -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.8%) to scientific vocabulary
Repository
Persistent coverage analysis tool using the d4 format
Basic Info
- Host: GitHub
- Owner: Clinical-Genomics
- Language: Python
- Default Branch: main
- Homepage: https://clinical-genomics.github.io/chanjo2/
- Size: 5.07 MB
Statistics
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 18
- Releases: 26
Metadata Files
README.md
chanjo2
Chanjo2 is coverage analysis tool for human clinical sequencing data using the d4 (Dense Depth Data Dump) format. It's implemented in Python FastAPI and provides API endpoints to communicate with a d4tools software in order to return reports containing coverage and coverage completeness over genomic intervals (genes, transcripts, exons as well as custom intervals) over d4 files.
Coverage and coverage overview reports
Chanjo2 can be directly used to create the same types of report produced by chanjo-report in conjunction with chanjo[chanjo]. Follow the instructions present in the documentation pages to learn how to use the report and the overview endpoints to create customised gene coverage report using this software.
Examples of reports available with chanjo2:
Coverage report
Genes coverage overview
Mane coverage overview
Gene overview
Run a software demo containing test data
A demo REST server connected with a temporary SQLite database can be launched using Docker:
shell
docker run -d --rm -p 8000:8000 --expose 8000 clinicalgenomics/chanjo2:latest
The endpoints of the app will be now reachable and described from any web browser: http://0.0.0.0:8000/docs or http://localhost:8000/docs
From a terminal, you can use the API to access the data contained in the demo database of this Chanjo2 instance. The available demo sample contains a d4 coverage file with a limited amount of genes in genome build GRCh37, those present in PanelApp gene panel 109 (Cerebral folate deficiency).
Examples of endpoints usage:
Loading genes to the database
In order to perform coverage queries over genes, transcripts and exons, these genomic intervals should be saved into the database first. Genes, transcripts and exons definitions are collected from Ensembl using a BioMart service.
To load genes in genome build GRCh37 from into the database send the following POST request to the server:
shell
curl -X 'POST' \
'http://localhost:8000/intervals/load/genes/GRCh37' \
-H 'accept: application/json' \
-d ''
The response will return the number of genes inserted in the database:
shell
{
"detail": "57849 genes loaded into the database"
}
To find more information on how to set up a REST server running chanjo2 please visit the software's documentation pages. Here you'll find also instructions on how to populate the database with custom cases and different genomic intervals.
Owner
- Name: Clinical Genomics
- Login: Clinical-Genomics
- Kind: organization
- Location: Stockholm, Sweden
- Website: https://clinical-genomics.github.io
- Repositories: 67
- Profile: https://github.com/Clinical-Genomics
GitHub Events
Total
- Create event: 70
- Release event: 12
- Issues event: 93
- Delete event: 46
- Issue comment event: 233
- Push event: 208
- Pull request review event: 1
- Pull request review comment event: 1
- Pull request event: 107
Last Year
- Create event: 70
- Release event: 12
- Issues event: 93
- Delete event: 46
- Issue comment event: 233
- Push event: 208
- Pull request review event: 1
- Pull request review comment event: 1
- Pull request event: 107
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 162
- Total pull requests: 243
- Average time to close issues: 2 months
- Average time to close pull requests: 3 days
- Total issue authors: 7
- Total pull request authors: 4
- Average comments per issue: 1.03
- Average comments per pull request: 3.02
- Merged pull requests: 208
- Bot issues: 0
- Bot pull requests: 3
Past Year
- Issues: 62
- Pull requests: 86
- Average time to close issues: 3 days
- Average time to close pull requests: about 13 hours
- Issue authors: 3
- Pull request authors: 2
- Average comments per issue: 0.76
- Average comments per pull request: 3.16
- Merged pull requests: 70
- Bot issues: 0
- Bot pull requests: 3
Top Authors
Issue Authors
- northwestwitch (129)
- Jakob37 (20)
- Mropat (7)
- moonso (2)
- dnil (2)
- ramprasadn (1)
- ehre (1)
Pull Request Authors
- northwestwitch (231)
- ramprasadn (6)
- dependabot[bot] (3)
- Vince-janv (3)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite
- psf/black stable composite
- actions/checkout v3 composite
- docker/build-push-action v4 composite
- docker/login-action v2 composite
- docker/setup-buildx-action v2 composite
- actions/checkout v3 composite
- docker/build-push-action v4 composite
- docker/login-action v2 composite
- docker/setup-buildx-action v2 composite
- actions/cache v3 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- abatilo/actions-poetry v2 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/cache v3 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- codecov/codecov-action v3 composite
- snok/install-poetry v1 composite
- Ana06/get-changed-files v2.2.0 composite
- actions/checkout v3 composite
- anaynayak/python-vulture-action v1.0 composite
- actions/checkout v3 composite
- get-woke/woke-action v0 composite
- clinicalgenomics/python3.11-venv-pyd4 1.0 build
- aiofiles 23.1.0
- anyio 3.6.2
- atomicwrites 1.4.1
- attrs 22.2.0
- certifi 2023.7.22
- charset-normalizer 3.0.1
- click 8.1.3
- colorama 0.4.6
- coverage 7.1.0
- decorator 5.1.1
- fastapi 0.68.2
- ghp-import 2.1.0
- greenlet 2.0.2
- gunicorn 20.1.0
- h11 0.14.0
- httpcore 0.16.3
- httpx 0.23.3
- idna 3.4
- importlib-metadata 6.6.0
- importlib-resources 5.12.0
- iniconfig 2.0.0
- jinja2 3.0.3
- markdown 3.3.7
- markupsafe 2.1.2
- mergedeep 1.3.4
- mkdocs 1.4.3
- mysqlclient 2.1.1
- numpy 1.24.2
- packaging 23.0
- pluggy 1.0.0
- py 1.11.0
- pyd4 0.3.6.2
- pydantic 1.10.4
- pytest 6.2.5
- pytest-cov 4.0.0
- pytest-mock 3.10.0
- python-dateutil 2.8.2
- python-dotenv 1.0.0
- python-multipart 0.0.5
- pyyaml 6.0
- pyyaml-env-tag 0.1
- requests 2.28.2
- rfc3986 1.5.0
- schug 1.2
- setuptools 67.2.0
- six 1.16.0
- sniffio 1.3.0
- sqlalchemy 1.4.46
- sqlalchemy2-stubs 0.0.2a32
- sqlmodel 0.0.4
- starlette 0.14.2
- toml 0.10.2
- tomli 2.0.1
- typer 0.4.2
- typing-extensions 4.4.0
- urllib3 1.26.14
- uvicorn 0.21.1
- validators 0.20.0
- watchdog 3.0.0
- zipp 3.15.0
- pytest ^6.2.5 develop
- fastapi ^0.68.1
- gunicorn ^20.1.0
- jinja2 ==3.0.3
- mkdocs ^1.4.3
- mysqlclient ^2.1.0
- pyd4 ^0.3.6.2
- pytest-cov ^4.0.0
- pytest-mock ^3.10.0
- python ^3.8
- python-dotenv ^1.0.0
- python-multipart ^0.0.5
- requests ^2.28.2
- schug ^1.2
- sqlmodel ^0.0.4
- uvicorn ^0.21.1
- validators ^0.20.0