rmetl

rMETL - realignment-based Mobile Element insertion detection Tool for Long read

https://github.com/tjianghit/rmetl

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.0%) to scientific vocabulary

Keywords

mei mei-detection nanopore-sequencing pacbio-data realignment transposons variant-calling
Last synced: 6 months ago · JSON representation

Repository

rMETL - realignment-based Mobile Element insertion detection Tool for Long read

Basic Info
  • Host: GitHub
  • Owner: tjiangHIT
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 1.02 MB
Statistics
  • Stars: 18
  • Watchers: 2
  • Forks: 4
  • Open Issues: 3
  • Releases: 3
Topics
mei mei-detection nanopore-sequencing pacbio-data realignment transposons variant-calling
Created over 8 years ago · Last pushed over 1 year ago
Metadata Files
Readme License

README.md

            __        __   ______   _________   _
     _ __  |  \      /  | |  ____| |___   ___| | |
    | ^__| |   \    /   | | |___       | |     | |
    | |    | |\ \  / /| | |  ___|      | |     | |
    | |    | | \ \/ / | | | |____      | |     | |____
    |_|    |_|  \__/  |_| |______|     |_|     |______|

rMETL - realignment-based Mobile Element insertion detection Tool for Long read

NOTE: The community users give the newest installation approach after 2023, which is referred to here.

PyPI version Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge


Introduction

Mobile element insertion (MEI) is a significant category of structure variations (SVs). The rapid development of long-read sequencing technologies provides the opportunity to detect MEIs sensitively. However, the signals of MEI implied by noisy long reads are highly complex due to the repetitiveness of mobile elements and the high sequencing error rates. Herein, we propose the Realignment-based Mobile Element insertion detection Tool for Long read (rMETL). Benchmarking results of simulated and real datasets demonstrate that rMETL has the ability to discover MEIs sensitively as well as prevent false positives. It is suited to produce high-quality MEI callsets in many genomics studies.


Simulated datasets

The simulated datasets used for benchmarking are available at Google Drive


Memory usage

The memory usage of rMETL can fit the configurations of most modern servers and workstations. Its peak memory footprint is about 7.05 Gigabytes (default setting), on a server with Intel Xeon CPU at 2.00 GHz, 1 Terabytes RAM running Linux Ubuntu 14.04. These reads were aligned to human reference genome hs37d5.


Dependences

1. pysam
2. Biopython
3. ngmlr
4. samtools
5. cigar

Python version 2.7

Installation

#install via pip
$ pip install rMETL

#install via conda
$ conda install -c bioconda rmetl

#install from GitHub
$ git clone https://github.com/tjiangHIT/rMETL.git (git clone https://github.com/hitbc/rMETL.git)
$ cd rMETL/
$ pip install .

The current version of rMETL has been tested on a 64-bit Linux operating system.

NOTE: The community users give the newest installation approach after 2023, which is referred to here.


Synopsis

Inference of putative MEI loci.

rMETL.py detection <alignments> <reference> <temp_dir> <output>

Realignment of chimeric read parts.

rMETL.py realignment <FASTA> <MEREF> <output>

Mobile Element Insertion calling.

rMETL.py calling <SAM> <reference> <out_type> <output>

Strongly recommend making the output directory manually at first.:blush:


Optional Parameters

Detection

| Parameters | Descriptions | Defaults | | :------------ |:---------------|:---------------| | MINSUPPORT |Mininum number of reads that support a ME.| 5 | | MINLENGTH | Minimum length of ME to be reported. |50| | MIN_DISTANCE | Minimum distance of two ME clusters. |20| | THREADS |Number of threads to use.|1| | PRESETS |The sequencing type of the reads.|pacbio|

Realignment

| Parameters | Descriptions | Defaults | | :------------ |:---------------|:---------------| | THREADS |Number of threads to use.|1| | PRESETS |The sequencing type of the reads.|pacbio| | SUBREADLENGTH |Length of fragments reads are split into.|128| | SUBREADCORRIDOR |Length of corridor sub-reads are aligned with.|20|

Calling

| Parameters | Descriptions | Defaults | | :------------ |:---------------|:---------------| | HOMOZYGOUS |The minimum score of a genotyping reported as homozygous.|0.8| | HETEROZYGOUS |The minimum score of a genotyping reported as a heterozygous.|0.3| | MINMAPQ |Mininum mapping quality.|20| | CLIPPINGTHRESHOLD |Mininum threshold of realignment clipping.|0.5| | SAMPLE |The name of the sample which is noted.|None| | MEI |Enables rMETL to display MEI/MED only.|False|


Citation

If you use rMETL, please cite:

Tao Jiang et al; rMETL: sensitive mobile element insertion detection with long read realignment, Bioinformatics, Volume 35, Issue 18, 15 September 2019, Pages 3484–3486, https://doi.org/10.1093/bioinformatics/btz106


Contact

For advising, bug reporting, and requiring help, please post on Github Issue or contact tjiang@hit.edu.cn.

Owner

  • Name: JiangTao
  • Login: tjiangHIT
  • Kind: user
  • Location: 92 West dazhi St, Nangang, Harbin, Heilongjiang Province, China
  • Company: Harbin Institute of Technology

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 124
  • Total Committers: 1
  • Avg Commits per committer: 124.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
tjiang t****g@h****n 124
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 8
  • Total pull requests: 1
  • Average time to close issues: about 2 months
  • Average time to close pull requests: less than a minute
  • Total issue authors: 7
  • Total pull request authors: 1
  • Average comments per issue: 2.25
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ggstatgen (2)
  • cangfengzhe (1)
  • Soniazumalave (1)
  • 120L021101 (1)
  • gbdias (1)
  • rl4940 (1)
  • Litterlemon (1)
Pull Request Authors
  • tjiangHIT (1)
  • amarkez (1)
Top Labels
Issue Labels
good first issue (2) bug (2) help wanted (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 10 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 2
  • Total maintainers: 1
pypi.org: rmetl

realignment-based Mobile Element insertion detection Tool for Long read

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 10 Last month
Rankings
Dependent packages count: 10.0%
Stargazers count: 14.8%
Forks count: 16.8%
Dependent repos count: 21.7%
Average: 24.8%
Downloads: 60.6%
Maintainers (1)
Last synced: 6 months ago

Dependencies

setup.py pypi
  • Biopython *
  • Cigar *
  • pysam *