Nanomotif is a Python package designed to explore methylation in prokaryotic genomes using Nanopore sequencing. Nanomotif is a fast, scalable, and sensitive tool for identification and utilization of methylation motifs in monocultures and metagenomic samples.
bin association of unbinned contigs (eg. plasmids)
association of MTases and RM-systems to motifs.
Documentation
Please see the documentation for detailed installation and usage instructions, descriptions of required files, and analysis examples.
Skip the Documentation: Your Quickstart Guide to Nanomotif
Installation
Nanomotif can easily be installed using Conda for managing your Python environments. You can create a new environment and install Nanomotif as follows:
This will generate a bin_contamination.tsv specifying the contigs, which is flagged as contamination.
If the –write_bins and the –assembly_file flags are specified new de-contaminated bins will be written to a bins folder.
See usage and output for detailed usage and output information.
Include unbinned contigs
The include_contigs command assigns unbinned contigs in the assembly file to bins by training three classifiers, random forest, linear discriminant analysis, and k neighbors classifier, on the methylation pattern of the bins.
Note: this is not a binner and included contigs should be considered putative. Methylation patterns can be shared across MAGs, which is problematic for unrecovered MAGs.
If decontamination should not be performed, the include_contigs can be run without the --run_detect_contamination flag or without the --contamination_file flag.
MTase-linker
This module tries to link methylation motifs to their corresponding MTase and, when present, their entire RM system.
The MTase-Linker module has additional dependencies that are not automatically installed with Nanomotif. Therefore, before using this module, you must manually install these dependencies using the MTase-linker install command.
The MTase-linker module requires that conda is available on your system.
nanomotif MTase-linker install
This will create a folder named ML_dependencies in your current working directory, containing the required dependencies for the MTase-linker module. You can use the --dependency_dir flag to change the installation location of the ML_dependencies folder.
The installation requires conda to generate a few environments, and it takes a bit time as it runs the workflow on a small dataset to check the installation.
When the additional dependencies are installed you can run the workflow using MTase-linker run
Running the nanomotif MTase-linker run command will generate two primary output files: mtase_assignment_table.tsv and nanomotif_assignment_table.tsv. The first file lists all predicted MTase genes in the genome along with their predicted methylation characteristics and whether the module was able to unambiguously assign any detected motifs to the MTase (linked = (True/False)).
The second file includes data from the bin-motifs.tsv of the nanomotif output with two additional columns linked and candidate_genes. The linked variable is a boolean indicator if the motif could be unambiguously linked to a MTase in the bin/genome (TRUE/FALSE). If True the gene_id of the MTase is provided in candidate_gene. If False, the candidate_gene variable lists feasible candidate facilitators of the modification based on motif type and modification type predictions.
Citation
Please cite our preprint if you use Nanomotif for your research:
Nanomotif: Leveraging DNA Methylation Motifs for Genome Recovery and Host Association of Plasmids in Metagenomes from Complex Microbial Communities.
Søren Heidelbach, Sebastian Mølvang Dall, Jeppe Støtt Bøjer, Jacob Nissen, Lucas Nicolaas Ludovic van der Maas, Mantas Sereika, Rasmus Kirkegaard, Sabrina Just Kousgaard, Ole Thorlacius-Ussing, Sheila I Jensen, Katja Hose, Thomas Dyhre Nielsen, Mads Albertsen. Preprint at bioRxivhttps://doi.org/10.1101/2024.04.29.591623 (2024)
License
Nanomotif is released under the MIT License. Feel free to use, modify, and distribute the package in accordance with the terms of the license.
Acknowledgments
Nanomotif builds upon various open-source libraries and tools that are instrumental in its functionality. We would like to express our gratitude to the developers and contributors of these projects for their valuable work.
Nanomotif
Nanomotif is a Python package designed to explore methylation in prokaryotic genomes using Nanopore sequencing. Nanomotif is a fast, scalable, and sensitive tool for identification and utilization of methylation motifs in monocultures and metagenomic samples.
Nanomotif offers
Documentation
Please see the documentation for detailed installation and usage instructions, descriptions of required files, and analysis examples.
Skip the Documentation: Your Quickstart Guide to Nanomotif
Installation
Nanomotif can easily be installed using Conda for managing your Python environments. You can create a new environment and install Nanomotif as follows:
Check installation
Once installed, the installation can be checked by running:
This runs a test run on a small dataset, ensuring everything works.
For further details, check out the installation guidelines.
Usage
Required files
To identify methylated motifs, the following files are required:
contig-binrelationship.For further details, check out the required files documentation.
Motif discovery
Whether you are interested in finding methylated motifs in monoculture samples or metagenomic samples, we recomment just running
motif_discoveryThis will create three files:
motifs.tsv,motif-scored.tsv, andbin-motifs.tsv. Highly methylated motifs are found inbin-motifs.tsv.See usage and output for detailed usage and output information.
Bin contamination
After motif identification it is possible to identify contamination in bins using the
bin-motifs.tsv,assembly,pileupandcontig_binfile.This will generate a bin_contamination.tsv specifying the contigs, which is flagged as contamination.
If the –write_bins and the –assembly_file flags are specified new de-contaminated bins will be written to a bins folder.
See usage and output for detailed usage and output information.
Include unbinned contigs
The
include_contigscommand assigns unbinned contigs in the assembly file to bins by training three classifiers, random forest, linear discriminant analysis, and k neighbors classifier, on the methylation pattern of the bins.If decontamination should not be performed, the
include_contigscan be run without the--run_detect_contaminationflag or without the--contamination_fileflag.MTase-linker
This module tries to link methylation motifs to their corresponding MTase and, when present, their entire RM system.
The MTase-Linker module has additional dependencies that are not automatically installed with Nanomotif. Therefore, before using this module, you must manually install these dependencies using the
MTase-linker installcommand. TheMTase-linkermodule requires that conda is available on your system.This will create a folder named
ML_dependenciesin your current working directory, containing the required dependencies for the MTase-linker module. You can use the--dependency_dirflag to change the installation location of theML_dependenciesfolder.The installation requires conda to generate a few environments, and it takes a bit time as it runs the workflow on a small dataset to check the installation.
When the additional dependencies are installed you can run the workflow using
MTase-linker runRunning the nanomotif MTase-linker run command will generate two primary output files: mtase_assignment_table.tsv and nanomotif_assignment_table.tsv. The first file lists all predicted MTase genes in the genome along with their predicted methylation characteristics and whether the module was able to unambiguously assign any detected motifs to the MTase (
linked= (True/False)). The second file includes data from the bin-motifs.tsv of the nanomotif output with two additional columnslinkedandcandidate_genes. Thelinkedvariable is a boolean indicator if the motif could be unambiguously linked to a MTase in the bin/genome (TRUE/FALSE). If True the gene_id of the MTase is provided incandidate_gene. If False, thecandidate_genevariable lists feasible candidate facilitators of the modification based on motif type and modification type predictions.Citation
Please cite our preprint if you use Nanomotif for your research:
Nanomotif: Leveraging DNA Methylation Motifs for Genome Recovery and Host Association of Plasmids in Metagenomes from Complex Microbial Communities. Søren Heidelbach, Sebastian Mølvang Dall, Jeppe Støtt Bøjer, Jacob Nissen, Lucas Nicolaas Ludovic van der Maas, Mantas Sereika, Rasmus Kirkegaard, Sabrina Just Kousgaard, Ole Thorlacius-Ussing, Sheila I Jensen, Katja Hose, Thomas Dyhre Nielsen, Mads Albertsen. Preprint at bioRxiv https://doi.org/10.1101/2024.04.29.591623 (2024)
License
Nanomotif is released under the MIT License. Feel free to use, modify, and distribute the package in accordance with the terms of the license.
Acknowledgments
Nanomotif builds upon various open-source libraries and tools that are instrumental in its functionality. We would like to express our gratitude to the developers and contributors of these projects for their valuable work.