1. NeoChr

NeoChr module would assist users to grab related genes in different pathways manually, to rewire genes’ relationship logically*, and to replace genes with ortholog that score higher*. Firstly, it would allow users to define gene order and orientation in DRAG&DROP way. Secondly, decoupled these genes if have overlap and make all genes are non-redundancy. Finally, add chromosome features to build a new chromosome and show in the JBrowse. Moreover, users can drag a window in the JBrowse and delete any gene in the window.
Note:
*These function are unavailable now, please wait for version 2.
**You can also add any thing here including your own water mark.

2. Plugin Scripts

This module contains three plugins: Decouple.pl, Add.pl and Delete.pl.

2.1 Decouple.pl

This plugin is to decouple the genes which have overlap gene regions. These overlapping genes can be decoupled if meet the following conditions: (1)If two genes have overlap gene regions, the latter gene 5’UTR does not cover the former gene initial codon (ATG); (2)Overlapping region initial coordinate is in the coding DNA sequences(CDS) of gene which is need to be decoupled; (3)The decouple site of CDS have synonymous substitute codon to replace; After decoupling, we use these non-redundancy genes to generate a GFF file and a FASTA file.

2.1.1 Internal operation

First, this plugin extracts base sequence from the genome file according to the gene order list, and records the gene order in the list. And then plugin records the annotation information according to the specie GFF file, moreover, plugin extends gene CDS upstream 600bp as 5’-UTR and downstream 100bp as 3’-UTR if the GFF file does not contain annotated these two features.
Second, this plugin detects the overlapping genes in the same chromosome. In case the overlapping genes are detected, it will judge whether the overlapping initial site is located in the CDS region, and identify the site is belong to phase0/1/2.
Third, the plugin attempts to synonymous substitute codon to break the initial codon intra the CDS. Printing information whether or not be decoupled successfully, such as:

And non-redundancy genes are generated.
Finally, the plugin links non-redundancy genes to construct a new chromosome according to the gene order.

2.2.1 Example

We have two input forms to execute the plugin:
1. Using string format as gene order list input form:
perl GeneDecouple.pl --species saccharomyces_cerevisiae_chr --list_format string --gene_order="YAL054C -,YAL038W +,YBR019C -,YBR145W +,YCL040W +,YCR012W +,YCR105W +,YDL168W +,YPL017C -,YIL177C -,YIL177W-A +,YIL172C -,YIL171W-A +,” --geneset_dir ../gene_set --upstream_extend 600 --downstream_extend 100 --neo_chr_gff neochr.gff --neo_chr_fa neochr.fa
2. Using file format as gene order list input form:
erl GeneDecouple.pl --species saccharomyces_cerevisiae_chr --list_format file --gene_order gene_ordre.list --geneset_dir ../gene_set --upstream_extend 600 --downstream_extend 100 --neo_chr_gff neochr.gff --neo_chr_fa neochr.fa

2.1.3 Parameters

Parameter	Description
list_format	set the input form of gene order list	string	string/file
gene_order	set the input gene order list file(include pathway genes and addition genes)
Parameter	Description	Default	Selectable range
geneset_dir	set the species annotation directory	600
upstream_extend	set the length of gene downstram(bp)	100
neo_chr_gff	set the name of output neochr gff file
neo_chr_fa	set the name of output neochr fasta file
help	Show help information

2.4.1 The format of output file

The output files are standard GFF and FASTA format files which are decoupled.
  1. decoupled GFF file

  2.decoupled FASTA file

2.2 Add.pl

This plugin will add the LoxPsym sequence and the customized left and right telomeres, centromere and autonomously replicating sequence (ARS) into the FASTA file and GFF file which are generated by Decouple.pl.

2.2.1 Internal operation

The plugin adds LoxPsym behind the first 3bp of 3’-UTR in each gene and adds telomere, centromere and ARS according this mode:
left_telomere + gene1 + centromere + gene2 + ARS + gene3 + right_telomere
The distance between centromere and ARS is less than 30Kb.
Finally, user can see the new added features chromosome according to the JBrowse.

2.2.2 Example

perl 04.Add.pl --loxp loxPsym.feat --left_telomere UTC_left.feat --right_telomere UTC_right.feat --ars chromosome_I_ARS108.feature --centromere chromosome_I_centromere.feat --chr_gff neochr.gff --chr_seq neochr.fa --neochr_seq neochr.final.fa --neochr_gff neochr.final.gff

All the feature file format is 4 lines format, for example:
  name = site_specific_recombination_target_region
  type = loxPsym
  source = BIO
  sequence = ATAACTTCGTATAATGTACATTATACGAAGTTAT
Note: the first line is the detail name of feature, the second line is the type of feature, the third line is the source of feature and the last line is the sequence of feature.

2.2.3 Parameters

Parameter	Description	Default	Selectable range
loxp	set the sequence of loxp	ATAACTTCGTATAATGTATGCTATACGAAGTTAT	
left_telomere	set the sequence of left telomere		
right_telomere	set the sequence of right telomere		
chr_gff	set the input neorchr_gff file		
chr_seq	set the input neorchr_gff file		
neochr_seq	set the name of output added loxps and telomeres neochr_fa file		
neochr_gff	set the name of output added loxps and telomeres neochr_gff file		

2.2.4 The format of output

The output files are standard GFF and FASTA format of adding features chromosome.
1. added features GFF file

2.3 Delete.pl

This plugin can modify the GFF and FASTA file which are generated by Add.pl according to the user drags a window in the JBrowse and delete any gene in the window.

2.3.1 Internal operation

Firstly, user uses mouse to drag a window in the added features FASTA file which is showed in the JBrowse and JBrowse displays all the genes in this window.Secondly, user decides which genes is need to be delected from the new chromosome and plugin deletes genes from GFF file and modify FASTA in the same time.

2.3.2 Example

perl 05.delete.pl --delete="YAL054C,YAL038W" --neochr_gff neochr.refine.final.gff --neochr_fa neochr.refine.final.fa --slim_gff neochr.refine.delete.gff --slim_fa neochr.refine.delete.fa

2.3.3 Parameters

Parameter	Description	Default	Selectable range
delete	Set the to be deleted gene list		
neochr_gff	Set the input GFF file which is generated by Add.pl		
neochr_fa	Set the input FASTA file which is generated by Add.pl		
slim_gff	Set the output GFF file		
slim_fa	Set the output FASTA file		

2.3.4 The format of ouput

The output files are standard GFF and FASTA format of deleted genes chromosome.

1. NucleoMod

NucleoMod can modify CDS based on synoymous mutation. It has 5 applications. Firstly, NucleoMod is used to design CRISPR sites on NeoChr so that we can silence the wild type genes. Secondly, it can erase specific enzyme sites according to the users' selection. Thirdly, users can create an enzyme site in selected region of specific genes. Fourthly, it can optimize the codon efficiency to increase the expression level. Finally, it can smash the tandem repeat bases to reduce the synthesis difficulty.

2. Plugins

This module contains 5 plugins: CRISPR design, erase enzyme site, create enzyme site, codon optimization, repeat smash. All plugins are included in the main program.

2.1 CRISPR design

This plugin is used to design CRISPR site of NeoChr genes so that we can silence the wild type genes. We use blast+ to ensure the uniqueness of CRISPR sites. If you are using more than one plugin at the same time, this plugin will start firstly and deliver the data to next plugin. Otherwise it will generate a new fasta file for sequence and gff file for annotation.

2.1.1 Internal operation

First, this plugin extracts sequence and annotation from the NeoChr FASTA file and GFF3 file, respectively. Regular expression will be applied to find the 23bp basic structure of CRISPR site, with a head of ‘G’ then following 20 facultative bases and finally followed by ‘GG’. All the sequences and locus will be record in an array.
Second, the blast+ will be used to check whether the 12bp sequences (from 9th to 20th) are uniq in the wild type genome. Only uniq sites will be reserved.
Third, synonymous substitution method will be applied to change one base between the 9th to 20th bases of the CRISPR structure. The result will be record in GFF as an element of gene. If –verbose is set, the designed number will be report in STDOUT.
Finally, if this plugin is the last module, the sequence and annotation information will be recreated in FASTA and GFF format.

2.1.2 Example

We have two input forms to execute the plugin:
Run CRISPR design plugin only:
perl NucleoMod.pl -inputfa NeoChr.fa -inputgff NeoChr.gff -outputgff new_annotation.gff -outputfa new_chr.fa -crisprnum 2 -database saccharomyces_cerevisiae_chr.fa

2.1.3 Parameters

Parameter	Description	Default	Selectable range
inputfa	The NeoChr sequence file in FASTA format		string
inputgff	The NeoChr annotation file in GFF3 format		string
outputgff	Output of new chromosome annotation in GFF3 format		string
outputfa	Output of new chromosome sequence in FASTA format		string
verbose	Output the detailed information in STDOUT	none	option
crisprnum	Number of CRISPR site to be design per gene		Int (>0)
database	The sequence of reference genome, used as blast+ database		string
help	Show help information

2.1.4 The format of output file

The output files are standard GFF and FASTA format files.
1. GFF file

2. FASTA file

3. Detailed information in STDOUT

2.2 Erase enzyme site

Given a list of restriction enzyme information, this plugin will erase the restriction sites in every gene. If you are using more than one plugin at the same time, this plugin will start after CRISPR design and deliver the data to next plugin. Otherwise it will generate a new fasta file for sequence and gff file for annotation.

2.2.1 Internal operation

The enzyme information will be extracted. (If the –borbrickstandard parameter is set, it will also remove EcoRI, XbaI, SpeI, PstI and NotI) The recognize site will be reformatted to regular expression and searched in the CDS regions. Once a restriction site is matched, synonymous substitution method will be applied to try to erase the enzyme site. When the substitution is finished, the plugin will restart the next search from 1 base after the last matched position. If this plugin is the last module, the sequence and annotation information will be recreated in FASTA and GFF format.

2.2.2 Example

perl NucleoMod.pl -inputfa NeoChr.fa -inputgff NeoChr.gff -outputgff new_annotation.gff -outputfa new_chr.fa –biobrickstandard [-delenzymelist enzyme.list ]

Format of enzyme.list:
Company enzyme_name enzyme_site …
　　Eg. NEB BamHI G/GATCC

2.2.3 Parameters

Parameter	Description	Default	Selectable range
inputfa	The NeoChr sequence file in FASTA format		string
inputgff	The NeoChr annotation file in GFF3 format		string
outputgff	Output of new chromosome annotation in GFF3 format		string
outputfa	Output of new chromosome sequence in FASTA format		string
verbose	Output the detailed information in STDOUT	none	option
biobrickstandard	Erase the biobrick standard enzyme site	none	option
delenzymelist	The file of enzyme going to delete		string
detail	Show the erased enzyme site in new gff	none	option
help	Show help information

2.2.4 The format of output

The output files are standard GFF and FASTA format.
1. GFF file
2. FASTA file
3. Detailed information in STDOUT

2.3 Create enzyme site

Given a list of restriction enzyme information, this plugin can create a new enzyme site in specific region of selected gene. If you are using more than one plugin at the same time, this plugin will start after erase enzyme site and deliver the data to next plugin. Otherwise it will generate a new fasta file for sequence and gff file for annotation.

2.3.1 Internal operation

First, information of enzyme site will be extracted. According to 3 reading frames, a searching tree will be constructed and converted to regular expression. The plugin will search the selected regions and then change the sequence to enzyme site by synonymous substitution method. If this plugin is the last module, the sequence and annotation information will be recreated in FASTA and GFF format.

2.3.2 Example

perl NucleoMod.pl -inputfa NeoChr.fa -inputgff NeoChr.gff -outputgff new_annotation.gff -outputfa new_chr.fa -addenzymelist enzyme.list -addenzymeconfig gene_id,start_pos,end_pos,enzyme_name

2.3.3 Parameters

Parameter	Description	Default	Selectable range
inputfa	The NeoChr sequence file in FASTA format		string
inputgff	The NeoChr annotation file in GFF3 format		string
outputgff	Output of new chromosome annotation in GFF3 format		string
outputfa	Output of new chromosome sequence in FASTA format		string
verbose	Output the detailed information in STDOUT	none	option
addenzymelist	The file of enzyme to get enzyme site information		string
addenzymeconfig	A array of string to specify enzyme and regions		string,int,int,string
help	Show help information

2.3.4 The format of ouput

The output files are standard GFF and FASTA format.
1. GFF file
2. FASTA file
3. Detailed information in STDOUT

2.4 Codon optimization

Given a codon priority list, this plugin is used to optimize the codon so that we can increase the expression of selected genes. If you are using more than one plugin at the same time, this plugin will start after create enzyme site and deliver the data to next plugin. Otherwise it will generate a new fasta file for sequence and gff file for annotation.

2.4.1 Internal operation

The codon with same amino acid will be separated into 3 ranks, best normal and worst. Every codon of selected gene will be check whether the codon is in best rank. The codon in normal or worst will be change to best rank by synonymous substitution method. If this plugin is the last module, the sequence and annotation information will be recreated in FASTA and GFF format.

2.4.2 Example

perl NucleoMod.pl -inputfa NeoChr.fa -inputgff NeoChr.gff -outputgff new_annotation.gff -outputfa new_chr.fa -codonoptimize CodonPriority.txt -optimizeallgene [-optimizegenelist gene1,gene2,gene3 ]

2.4.3 Parameters

Parameter	Description	Default	Selectable range
inputfa	The NeoChr sequence file in FASTA format		string
inputgff	The NeoChr annotation file in GFF3 format		string
outputgff	Output of new chromosome annotation in GFF3 format		string
outputfa	Output of new chromosome sequence in FASTA format		string
verbose	Output the detailed information in STDOUT	none	option
codonoptimize	Codon priority list to get the ranking information		string
optimizeallgene	Optimize all genes in inputgff		option
optimizegenelist	A list of gene going to optimize, separate by comma		string,string,string,...
detail	Show the optimization sequence in new gff	none	option
help	Show help information

2.4.4 The format of ouput

The output files are standard GFF and FASTA format.
1. GFF file
2 .FASTA file
3. Detailed information in STDOUT

2.5 Repeat smash

This plugin go through the CDS region to find out the tandem repeat bases. Synonymous substitution method will be applied to break long tandem repeat base to reduce the synthesis difficulty. If you are using more than one plugin at the same time, this plugin will start finally and then it will generate a new fasta file for sequence and gff file for annotation.

2.5.1 Internal operation

Regular expression is used to find out the tandem repeat bases longer then specified length (usually longer than 5bp). From the third of the matched sequence, synonymous substitution method will be applied to break the tandem repeat bases. If the substitution is successful and the rest sequence is still longer than the cutoff, then it will move to next 3 bases and do the same thing. The sequence and annotation information will be recreated in FASTA and GFF format.

2.3.2 Example

perl NucleoMod.pl -inputfa NeoChr.fa -inputgff NeoChr.gff -outputgff new_annotation.gff -outputfa new_chr.fa -repeatsmash 5

2.3.3 Parameters

Parameter	Description	Default	Selectable range
inputfa	The NeoChr sequence file in FASTA format		string
inputgff	The NeoChr annotation file in GFF3 format		string
outputgff	Output of new chromosome annotation in GFF3 format		string
outputfa	Output of new chromosome sequence in FASTA format		string
verbose	Output the detailed information in STDOUT	none	option
repeatsmash	The tandem repeat bases longer or equal to this cutoff will be smashed		int
detail	Show the repeat smash result in new gff	none	option
help	Show help information

2.3.4 The format of ouput

The output files are standard GFF and FASTA format.
1. GFF file
2. FASTA file
3. Detailed information in STDOUT

3. SegmMan

This module will cut chromosome into pieces with different sizes with Gibson, Goldengate, Homologous adaptors to them so that they are able to be assembled into whole experimentally.

Plugin Scripts

3-1. 01.whole2mega.pl

This utility can split the whole chromosome ( at least 90kbp long ) into about 30k segments and add homologous overlap and adaptors, so that these fragments can be integrated into whole experimentally.

Internal operation

First, this utility searches for the location of centromere and ARSs (autonomously replicating site). The minimal distance between centromere and ARS should NOT be larger than a defined megachunk which is about 30k long.
Second, this utility cuts out the first 30k sequence window containing the centromere and its adjacent ARS, and then adds this megachunk with two original markers and left, right telomeres.
Thirdly, this utility continues to cut more megachunks from the original one to both ends. But these megachunks are not independent, they all have about 1kbp overlaps. Moreover, these new splited window can be given only one marker alternately and only left or right telomere.
The output file will be dealed with 02.globalREmarkup.pl
For more information about segmentation design, please refer to the page ASSEMBLY DESIGN PRINCIPLE .

Example (command line)

perl 01.whole2mega.pl –gff sce_chrI.gff -fa sce_chr01.fa -ol 1000 -ck 30000 -m1 LEU2 -m2 URA3 -m3 HIS3 -m4 TRP1 -ot sce_chrI.mega

Parameters

		default	Option
gff	The gff file of the chromosome being restriction enzyme sites parsing
fa	The fasta file of the chromosome being restriction enzyme sites parsing (The length of the chromosome is larger than 90k)
ol	The length of overlap between megachunks	1000bp
ck	The length of megachunks	30kbp
m1	The first marker for selection alternately	LEU2 (1797bp)	LEU2/URA3HIS3/TRP1
m2	The second marker for selection alternately	URA3 (1112bp)	LEU2/URA3/HIS3/TRP1
m3	The first marker orinally residing in first 30k segmentation	HIS3 (1774bp)	LEU2/URA3/HIS3/TRP1
m4	The second marker orinally residing in first 30k segmentation	TRP1 (1467bp)	LEU2/URA3/HIS3/TRP1
ot	The output file	Prefix(fa filename)+ suffix(.mega)

The format of output:

The output file is stored in /the path where you install GENOVO/Result/ 01.whole2mega.
Besides, there is screen output about the process state and result.
1. Screen output
2. 01.state
 Store the segmentation information

Megachunk_ID	Corresponding location in the designed chromosome
Part ID	Location in the segmentation

3 *.mega
 Store the fasta information of the 30k segments

3-2. 02.globalREmarkup.pl

This utility will parse the exited restriction enzyme sites residing in the chromosome.

Internal operation

This utility searches the exited restriction enzyme sites along the chromosome both plus strand and minus strand, after users define the list of enzymes.
Besides, we tried to find out all the potential restriction enzyme sites, so that maybe some unusual restriction enzyme sites can be created and let segmentation go. But because it had low efficiency, we’re still working on that.
The output file will be dealed with 03.mega2chunk2mini.pl
For more information about segmentation design, please refer to the page ASSEMBLY DESIGN PRINCIPLE .

Example (command line)

perl 02.globalREmarkup.pl -sg 01.whole2mega/sce_chrI.mega -re standard_and_IIB -ct Standard.ct –ot sce_chrI.mega.parse

Parameters

		default	Option
sg	The fasta file of the 30k segmentation, the output of 01.wh2mega.pl
ps	The markup file of the 30k segmentation, the output of 02.globalREmarkup.pl
re	The restriction enzyme sites list. It is devided by different standards, type (IIP, IIA, IIB), cost (standard, nonexpensive) and etc.	Standard_and_IIB	IIP/IIA/IIB/Standard/ Nonexpensive/ Standard_IIB Nonexpensive_IIB
a2	2k to 10k assembly strategy (Gibson or Goldengate)	Gibson	Gibson/ Goldengate
a10	10k to 30k assembly strategy (Gibson or Goldengate)	Goldengate	Gibson/ Goldengate
ckmax2	The maximum length of minichunks	2200 bp
ckmin2	The minimum length of minichunks	1800 bp
cknum	The number of minichunks in a chunk	5

Codon table list:
1 The Standard Code
2 The Vertebrate Mitochondrial Code
3 The Yeast Mitochondrial Code
4 The Mold, Protozoan, and Coelenterate Mitochondrial Code and the Mycoplasma/Spiroplasma Code
5The Invertebrate Mitochondrial Code
6 The Ciliate, Dasycladacean and Hexamita Nuclear Code
7 The Echinoderm and Flatworm Mitochondrial Code
8 The Euplotid Nuclear Code
9 The Bacterial, Archaeal and Plant Plastid Code
10 The Alternative Yeast Nuclear Code
11 The Ascidian Mitochondrial Code
12 The Alternative Flatworm Mitochondrial Code
13 Blepharisma Nuclear Code
14 Chlorophycean Mitochondrial Code
15 Trematode Mitochondrial Code
16 Scenedesmus Obliquus Mitochondrial Code
17 Thraustochytrium Mitochondrial Code
18 Pterobranchia Mitochondrial Code
19 Candidate Division SR1 and Gracilibacteria Code

The format of utput

The output file is stored in /the path where you install GENOVO/Result/. 02.globalREmarkup.
Besides, there is screen output about the process state and result.
1. Screen output
2. *.parse
Store the exited enzyme recognition site in the megachunks
Enzyme ID Start End Recognition site Real site

3-3. 03.chunk_30k_10k_2k.pl

This utility can produce 2k minichunks with Gibson adaptors and 10k chunks with goldengate adaptors.

Internal operation

This utility will segmentate the megachunk produced by 03.mega2chunk2mini.pl into 2k minichunks with Gibson assembly adaptors, so that they can be put together into 10k chunks.
First, this bin will search the inexistent restriction enzyme sites locally, and then decide the size of the minichunks according to the requirements from users, and add two same Gibson adaptors to each sides of minichunks. Secondly, the second part of this bin will define the start and end point of the chunks as users asked and design goldengate assembly adaptors for the chunks.
The output file can be sent in gene synthesis company after human attention and double check.
For more information about segmentation design, please refer to the page ASSEMBLY DESIGN PRINCIPLE .

Example (command line)

perl 03.mega2chunk2mini.pl -re standard_and_IIB -sg 01.whole2mega/sce_chr01_0.mega -ps 02.globalREmarkup/sce_chr01_0.parse -ot 03.mega2chunk2mini

Parameters

		default	Option
sg	The fasta file of the 30k segmentation, the output of 01.wh2mega.pl
ps	The markup file of the 30k segmentation, the output of 02.globalREmarkup.pl
re	The restriction enzyme sites list. It is devided by different standards, type (IIP, IIA, IIB), cost (standard, nonexpensive) and etc.	Standard_and_IIB	IIP/IIA/IIB/Standard/ Nonexpensive/ Standard_IIB Nonexpensive_IIB
a2	2k to 10k assembly strategy (Gibson or Goldengate)	Gibson	Gibson/ Goldengate
a10	10k to 30k assembly strategy (Gibson or Goldengate)	Goldengate	Gibson/ Goldengate
ckmax2	The maximum length of minichunks	2200 bp
ckmin2	The minimum length of minichunks	1800 bp
cknum	The number of minichunks in a chunk	5

If parameter a2 is Gibson, then there are additional parameters:

ol2	The length of overlap	40 bp
tmax2	The maximum melting temperature of the overlap of minichunks	60℃
tmin2	The minimum melting temperature of the overlap of minichunks	56℃
fe2	The minimum free energy of the overlap of minichunks	-3
ex2	The type of exonuclease used for minichunks	T5	T5/T3
lo2	The minimum distance between minichunks overlap and loxpsym	40 bp
en2	The type of enzyme flanking minichunks	IIP
et2
ep2	The maximum unit price of enzyme used in minichunks digestion	0.5 $/unit

If parameter a10 is Goldengate, then there are additional parameters:

en10	The type of enzyme flanking chunks	IIB	IIA/IIB
et10	The temperature of enzyme used in chunks digestion	37℃

The format of ouput

The output file is stored in /the path where you install GENOVO/Result/. 03.mega2chunk2mini.
Besides, there is screen output about the process state and result.
1. Screen output
2. *.2kstate
Store the minichunks states.

Left IIP enzyme site

Right IIP enzyme site

Start

End

Size of minichunks

Melting temperature of overlap

3. *.10kstate
Store the chunks states
Size of chunks

Left IIB enzyme site

Right IIB enzyme site

Start

End

4. *.mini
Store the fasta of designed minichunks.

Presentation from KGML

This module will grab genes’ details in different pathways, which from KEGG with KEGG Makeup Language (KGML) file and export genes list and relationship of genes. The goal here is to visualize the pathway and rebuild it in the level of genes.

Scripts
1. keggid_convert_gene.pl

This utility can convert KEGGID which in KGML file into genes’ name and rewrite KGML file.

Internal operation

First, this utility will change the pathway’s name into KEGG database names, and then open the file with the entire list of genes, push them in hash.
Second, this utility will read the original pathway’s xml file in and replace KEGGID with gene’s name one by one. Furthermore, it will change type element all into “gene”.
Thirdly, it will be the substitution of original pathway’s xml file.

Example

perl keggid_convert_gene.pl ko04010

The format of output:

It will rewrite the original pathway’s xml file, if we have following statement:
After running this scripts, it will turn into:

convert.py

This utility will read in KGML file which have been rewritten before, and grab genes’ information, such as genes’ name, genes’ relationship and then convert these into JSON.

Internal operation

First, this utility will use the parameter –f to determine the specified file and read it in. The output file will use the file name that put forward.
Second, this utility convert KGML file into JSON and grab the information of genes, such as the reactions of genes and the relationship between genes.
Third, this utility continue to integrate the information above into two files, ‘gene.json’ and ‘relation.json’, which can be use directly in rewrite gene’s pathway.

Example

python convert.py –f sce04111

Parameters:

	default
-f/--file	read KGML from FILENAME(omit '.xml'), produce two files: gene list and relation

The format of output:

The output file is stored in the path where you running this program.
1. _gene.json
type:

ortholog	KO (orthology group)
enzyme	Enzyme
reaction	Reaction
gene	gene product (mostly a protein)
group	a complex of gene products (mostly a protein complex)

geneID:the unique identification of gene

name	the KEGGID of this gene
type	the type of this gene

reaction:

name	the KEGGID of this reaction
reversible	true: reversible reaction; false: irreversible reaction
substrates	KEGGID of substrate node
products	the KEGGID of product node
related-reactions	relate to another pathway or gene

2. _relation.json relations:

type	The type of this relation[ ECrel, PPrel. GErel, PCrel, maplink]
subtype	Interaction/relation information[activation/inhibition]
entry1	The first (from) entry that defines this relation
entry2	The second (to) entry that defines this relation

entry1&2:

entry ID	The KEGGID of node which takes part in this relation
type	Have only two options: [gene/group]
name	The KEGGID of this gene
group	The node is a complex of gene products (mostly a protein complex)

Shortcoming

We can’t automatic acquisition KGML file in the KEGG API, all the demo we have show need to be downloaded before. You can get the entire list of one database genes through KEGG API, just like http://rest.kegg.jp/list/ko , it shows the entire list of orthology genes. The download method about KGML files shows in “How to finish this plun-in” part. Some genes will relate to another pathway but it doesn’t shows in the pathway so we are failed to grab the relationships between genes and pathways automatically. So we added two gene-pathway relations in ko04010 demo manually, TP53 gene connected with ko04115: P53 signaling pathway and NLK gene connected with ko04310: WNT signaling pathway. We look forward to the improvement of this plun-in through these disadvantages.

How to finish this plun-in?

KEGG is a database resource for understanding high-level functions and utilities of the biological system, and KGML is an XML presentation of the KEGG pathway database, which enables automatic drawing of KEGG pathways and provides facilities for computational analysis and modeling of gene/protein networks and chemical networks. Here is the data structure of KGML.
It’s really complex and it will bother you to understand the KGML file! Do not worry, I will show you how to understand a KGML file and then how to convert it into JSON.
First, how to find or download KGML file?
Method:
Download KGML" link for each pathway map.
If you choose a pathway with prefix “map”, you can’t find the download link in the page, that’s because it can be generating almost ko/rn/ec/org files.
Such as “map04111”, it has no link for download. But if you change the “map” into “sce” in the URL, you can get the file.
KEGG API: Take “sce04111” as an example, you can download the KGML file via the this.
Second, the KGML file is difficult to find out the relationship through the data structure show above.
Here is the simple but straightforward tutorial to teach you how to understand a KGML file.
Take “sce04111.xml” as an example. We can simplify the data structure as:

The entry element can be path/ko/ec/rn/cpd/gl/org/group, enzyme/protein/gene will have relation and gene will also have compound and reactions. We choose one relation to be example:
It means that gene (YCL061C) have activation effect in gene (YPL153C).By the way, through the graphics elements, we can definitely rewrite the connection between these two genes.
Third, thought we know how to get KGML file and can understand it but the crucial problem is, how to grab the information of genes and convert it into JSON.
Here we use Python programming Language, install the library “lxml” for processing XML and HTML, and we import JSON library for convert.
Fourth, you may ask: If there have any other software to do such job, that is read KGML files, convert it and rewrite it?
Of course, and we indeed tried but failed for it’s not open source or the original source is difficult for modification. Actually, if you want to do some visualize pathway job, Cytoscape is a good choice and it also have cytoscape.js for drawing.
Finally, we indeed done plentiful preparatory work, maybe in the end it’s not useful in this software but it can expand our horizons.