Telomerecat (Telomere Computational Analysis Tool)
| Master | Develop |
|---|---|
 |
 |
Telomerecat is a tool for estimating the average telomere length (TL) for a paired end, whole genome sequencing (WGS) sample.
Telomerecat is adaptable, accurate and fast. The algorithm accounts for sequencing amplification artifacts, anneouploidy (common in cancer samples) and noise generated by WGS. For a high coverage WGS BAM file of around 100GB telomerecat can produce an estimate in ~1 hour.
Docker container
Telomerecat is available as a Docker container on Quay.io.
No "latest" image is defined, you need to specify the version you require, e.g.:
export VERSION_TEL=3.4.1 # update as appropriate
docker pull quay.io/wtsicgp/telomerecat:${VERSION_TEL}
Singularity
The docker container is known to work with singularity, save the image locally via:
export VERSION_TEL=3.4.1 # update as appropriate
singularity pull docker://quay.io/wtsicgp/telomerecat:${VERSION_TEL}
INSTALL
Installation is via pip. Simply execute with the URL to a package release, e.g.:
pip3 install telomerecat
Basic usage
Please see the command line help:
telomerecat --help
Processes
When selecting the number of processes/threads the following should be considered:
- Single sample/input - 1, 2 or 4 recommended
- Multi sample/input - even values
- parallel bam2telbam processes will be started with 2 cpus each (assuming >2 processes)
Package Dependancies
pip will install the relevant dependancies, listed here for convenience:
Development Dependencies
You will need virtualenv available on your system.
Create a virtual python environement
cd $PROJECTROOT
python3 -m venv env
source env/bin/activate
python setup.py develop # so bin scripts can find module
Cutting a release
- Check version in
setup.pyhas been updated - Check parabam version in
setup.py/Dockerfile - Follow standard Hubflow release process (within cancerit)
CircleCI will handle docker image push to quay.io and package deployment to pypi.
Release files for telomerecat 4.0.1
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 | |
|---|---|---|---|---|
| telomerecat-4.0.1.tar.gz | 33.2 kB | Without provenance | Details |
Release files / telomerecat-4.0.1.tar.gz
| Download URL | telomerecat-4.0.1.tar.gz |
|---|---|
| Size | 33.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c0e595f3a93a9aa3a45db12bdf6cdf2d8b5a2b6c4697f4ca6e5e8a5065543cd4
|
|
BLAKE2b-256 checksum How to use checksums |
b1844c9012953be24ca4b589fde0c25e5b4f46720502d73ebc0139b12d705f09
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.7.11
|
Security for telomerecat 4.0.1
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.
