README.md

SyntenyLink

Table of Contents

1. Overview
2. Requirements
3. Installation
4. Usage
5. Main programs
6. Contact
7. License

Overview

===========

The SyntenyLink package has six major components: the SyntenyLink algorithm allows users to handle reconstruct subgenomes of polyploid species more conveniently and to separate the set of genes belong to each subgenome in the organism with the aid of reference proteomes of polyploid species and related ancestor.

For more details access our published work here: https://ieeexplore.ieee.org/document/10385622

All programs are executed using command line options on Linux systems or Mac OS. Usage or help information are well built into the programs.

All code is copiable, distributable, modifiable, and usable without any restrictions.

Requirements

=============

To use SyntenyLink, ensure you have the following requirements and python packages:

Python packages:

- Python
- biopython
- ipython
- matplotlib
- numpy
- pandas
- seaborn
- pickle
- csv
- os
- math
- sys
- re
- warnings

Other tools:

- makeblastdb
- blastall
- dagchainer

Installation

=============

1. Clone this repository to your local machine:

git clone https://git.cs.usask.ca/qnm481/syntenylink.git
cd syntenylink

2. Install the required dependencies:

pip install -r requirements.txt

How to use SyntenyLink

=============

3. Reproduce all the experiments:

i. Run SyntenyLink.sh

./SyntenyLink.sh ref_pep.fasta ref_cds.fasta query_pep.fasta query_cds.fasta query.gff3 ref.gff3 ref_genelist.txt query.bed -n <number of subgenomes> -s <ploidy status> -chr1 <query chromosome number for subgenome1> -p <gene prefix> 

More information

=============

Utilize this repository to replicate our experiments and explore the functionalities of SyntenyLink. The codebase is organized to help you easily navigate through different components and reproduce our results.

The following is the list of executable programs

Usage

=============

Parameter and command examples are shown below.

1. SyntenyLink.sh
   • -i Input collinear file
   • -s Ploidy status. If diploid 2, tetraploid 4, hexaploid 6, octaploid 8
   • -p Gene prefix.
   • -gt Groundtruth subgenome separation. Default is None
   • -bed Query bed file
   • -chr Chromosome number for each subgenome. For example in Brassica napus chr1 is 10 and chr2 is 9
   • -n number of subgenomes.
   • -sub Prefix for subgenome chromosome name. For example in Brassica napus sub1 is A and sub2 is Chromosome
   • -dag Collinear file created with blastn output

Contact

===============

For any questions or inquiries, please feel free to open an issue on our repository or contact us at qnm481@usask.ca.

License

===============

This project is licensed under the MIT License