hgfind
Get the human genome (hg38) coordinates of a gene
Installation
pip install hgfind
Requirements:
- Python >=3.6
Usage
hgfind can be used either on the command line or as a function within
Python
As a commandline tool
hgfind <gene>
where gene is a gene name such as "PTEN". The name can be a synonym as well.
A successful example:
$ hgfind auf1
HNRNPD => 4:82352498-82374503 (-)
$ echo $?
0
The result shows that HNRNPD (a synonym for AUF1) lies on chromosome 4,
in the specified base interval. The (-) indicates that its transcripts
all lie on the reverse strand.
Using an unrecognized name results in an error:
$ hgfind fjlsfl
fjlsfl not recognized as a gene
$ echo $?
1
As a function in Python
As an example on the Python REPL:
>>> from hgfind import hgfind
>>> hgfind("Neat2")
{'chr_n': 11, 'start_coord': 65497688, 'end_coord': 65506516, 'strand': '+', 'official_name': 'MALAT1'}
Using an unrecognized name results in an error:
>>> hgfind("gewgwre")
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "hgfind.py", line 140, in hgfind
raise WrongGeneName(
hgfind.WrongGeneName: {'message': 'The input gene could not be recognized', 'gene': 'GEWGWRE'}
Contributing
Any suggestions / PR requests are welcome!
Development
Enable recommended Git Hooks as follows:
git config --local core.hooksPath .githooks/
The above will run the following to ensure code consistency every time you commit:
Also use fit-commit to ensure consistent commit message style.
Metadata
Release files for hgfind 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| hgfind-1.0.0.tar.gz | 1.3 MB | Without provenance | Details for hgfind-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| hgfind-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for hgfind-1.0.0-py3-none-any.whl |
Total release size: 2.6 MB
Release files / hgfind-1.0.0.tar.gz
| Download URL | hgfind-1.0.0.tar.gz |
|---|---|
| Size | 1.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b3af9413e1b6716e483637104a602f76a80254c12040e8c1bea23a1ba1cba3ad
|
|
BLAKE2b-256 checksum How to use checksums |
dd2131a657720e332377b4cb47ec47214441df9d711cd973e0ea48cc2faad170
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.6
|
Release files / hgfind-1.0.0-py3-none-any.whl
| Download URL | hgfind-1.0.0-py3-none-any.whl |
|---|---|
| Size | 1.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4a1f6102b0c9f7fc7e51be23f7dedfb3bb81e78195b0e80e2346c4280dcc3251
|
|
BLAKE2b-256 checksum How to use checksums |
8520e6c9c57937af021d32baf6c5c54ddb333d103013c700659c2826cc2ca11e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.6
|
Security for hgfind 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.