Metadata-Version: 2.1
Name: uniqmin
Version: 1.0.0
Summary: An alignment-independent tool for the study of pathogen sequence diversity at any given rank of taxonomy lineage
Home-page: UNKNOWN
Author: Chong LC
Author-email: <lichuinchong@gmail.com>
License: UNKNOWN
Project-URL: Github, https://github.com/ChongLC/MinimalSetofViralPeptidome-UNIQmin
Description: # UNIQmin: An alignment-independent tool for the study of pathogen sequence diversity at any given rank of taxonomy lineage
        
        [![DOI - 10.3390/biology10090853](https://img.shields.io/badge/DOI-10.3390%2Fbiology10090853-2ea44f)](https://doi.org/10.3390/biology10090853)
        [![ChongLC - MinimalSetofViralPeptidome-UNIQmin](https://img.shields.io/static/v1?label=ChongLC&message=UNIQmin&color=blue&logo=github)](https://github.com/ChongLC/MinimalSetofViralPeptidome-UNIQmin)
        [![stars - MinimalSetofViralPeptidome-UNIQmin](https://img.shields.io/github/stars/ChongLC/MinimalSetofViralPeptidome-UNIQmin?style=social)](https://github.com/ChongLC/MinimalSetofViralPeptidome-UNIQmin)
        [![forks - MinimalSetofViralPeptidome-UNIQmin](https://img.shields.io/github/forks/ChongLC/MinimalSetofViralPeptidome-UNIQmin?style=social)](https://github.com/ChongLC/MinimalSetofViralPeptidome-UNIQmin)
        [![License](https://img.shields.io/badge/License-MIT-blue)](#license)
        
        
        ### Brief Description
        Sequence variation among pathogens, even of a single amino acid, can expand their host repertoire or enhance the infection ability. Alignment independent approach represents an alternative approach to the study of pathogen diversity, which is devoid of the need for sequence conservation to perform comparative analyses. Herein, we present UNIQmin, a tool that utilises an alignment independent method to generate the minimal set of pathogen sequences, as a way to study their diversity, across any rank of taxonomic lineage. The minimal set refers to the smallest possible number of sequences required to capture the entire repertoire of pathogen peptidome diversity present in a sequence dataset.
        
        ### Installation
        `pip install UNIQmin`
        
        ### Usage
        `UNIQmin [-i INPUT] [-o OUTPUT] [-k [KMERLENGTH]] [-cpu [CPUSIZE]]`
        
        For example, UNIQmin tool is applied to generate a minimal set (example) with a sample input file (exampleinput.fas). A *k*-mer window size of nine (9; nonamer) is used with utilising 14-cores. 
        
        `UNIQmin -i exampleinput.fas -o example -k 9 -cpu 14`
        
        ### Command-line Arguments
        | Argument 	| Parameter              | Type    	| Default 	| Description                                |           
        |----------	|----------------------- |---------	|---------- |--------------------------------------------|
        | -h       	| help                   | N/A     	| N/A     	| Show this help message and exit            |
        | -i       	| sequence input file    | String  	| N/A     	| Path of the input file (in FASTA format)   |
        | -o       	| output directory name  | String  	| N/A     	| Path of the output file to be created      |
        | -k        | *k*-mer window size    | Integer 	| 9       	| The length of *k*-mers to be used          |
        | -cpu      | cpu size               | Integer 	| 14       	| The number of CPU cores to be used         |
        
        
        ### License
        © 2021 Chong LC
        
        This repository is licensed under the MIT license.
        See LICENSE for details.
Keywords: pathogen,sequence diversity,alignment-independent
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Unix
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Description-Content-Type: text/markdown
