NGenomeSyn

Multi-level visualization of genomic statistical variables on rectangular chromosomes

1 Introduction

NGenomeSyn 是于基于多个基因组共线性关系的可视工具，对多个基因组自主排列位置，扩长收缩，旋转角度等，结合颜色，达到快速一眼看出规律，识别结果。并且各种可以自己组合自由修改相关参数。

亮点：
1 任意多个基因组（目前我限12个，可以取消）
2 各个基因组可以自己调顺序颜色等等属性
3 各个基因组可以移动旋转扩长和收缩等

其中3 可以调好相关参数可以出现三角形五角形四边形等等组合（后面将有空升组调定这些参数）

程序是给一些有基础的生信朋友用的，若是小白看不懂就算了。

NGenomeSyn ,It is a visual tool based on the collinear relationship of multiple genomes, which independently arranges the positions, expansion and contraction, rotation angles, etc. of multiple genomes, combined with colors, to quickly see the rules and identify the results at a glance. And various can be combined by themselves to freely modify the relevant parameters

2 Download and Install

The new version will be updated and maintained in hewm2008/NGenomeSyn, please click below website to download the latest version

hewm2008/NGenomeSyn

2.1. linux/MaxOS Download

2.2 Pre-install
NGenomeSyn is for Linux/Unix/macOS only. Before installing,please make sure the following pre-requirements are ready to use.
1) Perl with the SVG.pm in Perl should be installed. SVG is not necessary,We have provided a built-in SVG module in the package.
2) convert command is recommended to be pre-installed, although it is not required

2.3 Install
Users can install it with the following options:
Option 1:

        git clone https://github.com/hewm2008/NGenomeSyn.git
        cd NGenomeSyn;	chmod 755 -R bin/*
        ./bin/NGenomeSyn  -h

3 Parameter description

3.1 NGenomeSyn
3.1.1 Main parameter

        Usage: NGenomeSyn  -InConfi  in.cofi -OutPut OUT

                -InConfi      <s> : InPut Configuration File
                -OutPut       <s> : OutPut svg file result

                -help               See more help *Manual.pdf
                                    [hewm2008 v0.20]

brief description for function:

	   # 用法和circos相似，主要一个配置文件一样,具体见pdf，简要功能介绍如下
	1  任意多个基因组（目前我限12个，可以取消）
	2  各个基因组可以自己调顺序 颜色等等属性
	3  各个基因组可以移动 旋转 扩长和收缩等
	
	其中3  可以调好相关参数 可以出现 三角形  五角形  四边形 等等组合（后面将有空升组调定这些参数）
	   更多[GetTwoGenomeSyn.pl](https://zhuanlan.zhihu.com/p/515695482)参数

3.1.2 Other parameters

     输入文件基因组格式见  pdf.主要为chr start end 等其它属性 的格式
     输入link件基因组格式见  pdf.主要为chrA  startA enda chrB startB endB   等等其它属性 的格式

3.2.2 Detail parameters

	#  具体见pdf
##################################### 全局参数 #######################################################
SetParaFor = global
GenomeInfoFile1=RefA.info
###### Format (chr Start End ...其它属性)  chr顺序和这文件一致 若是End Start 则这条chr反向互补
##  其它属性 如fill=red stroke-width=0  stroke=black stroke-opacity=1 fill-opacity=1 等等可以不同行不同属性
GenomeInfoFile2=RefB.info  ##  GenomeInfoFile X  就表示有 X个基因组

LinkFileRef1VsRef2=Link
####### Format (chrA StartA EndA chrB StartB End ...其它属性)
#  可以多次Ref1VsRef2   LinkFileRef2VsRef1 等


##Main = "main_Figure"  ##  the Fig Name  :MainRatioFontSize MainCor ShiftMainX  ShiftMainY 
## font-size 

################################ Figure ############################################################

##############################     画布 和 图片 参数配置 #################################
#body=1200   ##   默认是1200，主画布大小设置  另外：up/down/left/right) = (55,25,100,120); #CanvasHeightRitao=1.0 CanvasWidthRitao=1.0
##RotatePng   = 0  ##  对Figure进行旋转的角度

SetParaFor = Genome1  #  ALL/GenomeX  X第X个基因组

#ZoomChr=1.0          ## chr长度 等大 缩小 or 扩大
#RotateChr=30         ## chr的起点 顺时针 旋转  xx 度
#ShiftX=0
#ShiftY=0             ##对这个基因组移动,也可以直接用MoveToX MoveToY 

#ChrWidth=20          ## 这个基因组chr的在画布的宽度
#LinkWidth=180        ## 这个基因组和下一个link的高度
#ChrSpacing=10        ## 这个基因组chr之间的空隙
#NormalizedScale=0    ## 用自己的标尺  相当该基因组与默认的基因组是否等长

#SpeRegionFile=        ## 文件,表记特别区域[格式chr start End （xx=yy加属性等]

##其它当很少用到的参数 EndCurveRadian=3/ 等等
## GenomeNameRatio GenomeName

SetParaFor = Genome2  #  ALL/GenomeX  X第X个基因组


SetParaFor=Link1  #  对第X个 Link X  File 进行设置
#StyleUpDown=           ## UpDown  DownUp  UpUP DownDown  四种形式
#Reverse=1              ## 反向link
#HightRation=1.0        ## links的高比例  扩大or缩小
####  fill/ stroke/stroke-opacity/fill-opacity/stroke-width   可设

....  #等等

3.3 Output files

out.svg: Output plot in SVG format
out.png: Output plot in png format

4 Example

See more detailed usage in the Chinese Documentation
See more detailed usage in the English Documentation
See the example directory and Manual.pdf for more detail.
具体见这儿 Manual.pdf for more detail 里面的实例和配置，后期将在某些网址释放一些教程

../../bin/NGenomeSyn -InConfi in.cofi -OutPut OUT
目录 Example/example*/ 里面有输入和输出和脚本用法。