methylink is a tool to link methylation tags between SAM/BAM files.
Project description
methylink
A command line tool to link methylated sites between two BAM/SAM files of the same origin.
Installation
In a clean :sparkles: environment
pip install methylink
Usage:
Usage: methylink [OPTIONS] COMMAND [ARGS]...
A command line tool to link methylated sites between two BAM files of the
same origin.
Options:
-h, --help Show this message and exit.
--version Show the version and exit.
--log_level [DEBUG|INFO|WARNING|ERROR|CRITICAL]
Set the level of log output. [default:
INFO]
--threads INTEGER Number of threads to use. [default: 1]
--tmp PATH Temp directory to use.
--methyl_bams TEXT Unmapped bam files with methylation tags.
[required]
--aln TEXT Aligned bam to map the meth tags to.
[required]
--sample TEXT Sample name. [required]
--output TEXT Output file. [required]
Quick start
methylink \
--threads 2 \
--aln tests/data/CHM1_aln_test-subsampled.bam \
--sample CHM1 \
--methyl_bams "$(echo tests/data/CHM1_methylated_test-{1,2,3,4,5}.bam)" \
--output CHM1-linked.bam
Development
I'm happy with any contributions to make this code better :muscle:. You should be able to go forth with the following:
git clone [this repo]
cd methylink
python -m venv vmeth
source vmeth/bin/activate
pip install --editable .
What remains to do-
- add to bioconda
- expand on documentation
- use signal library to catch for forced exit (eg. ctrl+c) to safely delete temp folders
- write github actions to automate test + build + publish
Test
pytest
If that's okay then you're good to go, :tada:!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
methylink-0.5.0.tar.gz
(8.2 kB
view hashes)
Built Distribution
Close
Hashes for methylink-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a095ab2c65ca9b20d5852deefbc1e33bcdb600ed188479ce674361e01da90cd |
|
MD5 | 0e141a3d0ced45510831232cf5f986b1 |
|
BLAKE2b-256 | a3dd0fcf524c4d95258a729ae82ed29f68b2c863957f43d1958b6ed8bc8494f4 |