Jump to content

SecStrAnnotator:OneToOne: Difference between revisions

From WebChemistry Wiki
Midlik (talk | contribs)
No edit summary
Midlik (talk | contribs)
No edit summary
Line 2: Line 2:


The annotation algorithm consists of three major steps. The first step is '''structural alignment and superimposition''' of the query protein with the template protein, so the corresponding parts of the two proteins are located close to each other. In the second step, '''secondary structure assignment (SSA)''' is performed – SSEs are detected in the query protein ''Q''. The third step is called '''matching''' – the algorithm will match the template SSEs to the query SSEs and for each annotated SSE in ''T'' it will select the corresponding SSE in ''Q''.
The annotation algorithm consists of three major steps. The first step is '''structural alignment and superimposition''' of the query protein with the template protein, so the corresponding parts of the two proteins are located close to each other. In the second step, '''secondary structure assignment (SSA)''' is performed – SSEs are detected in the query protein ''Q''. The third step is called '''matching''' – the algorithm will match the template SSEs to the query SSEs and for each annotated SSE in ''T'' it will select the corresponding SSE in ''Q''.


==Execution==
==Execution==
Line 12: Line 13:
Unix:
Unix:
  mono SecStrAnnotator.exe <span style=color:gray>[</span><span style=color:green>OPTIONS</span><span style=color:gray>]</span> <span style=color:green>DIRECTORY</span> <span style=color:green>TEMPLATE</span> <span style=color:green>QUERY</span>
  mono SecStrAnnotator.exe <span style=color:gray>[</span><span style=color:green>OPTIONS</span><span style=color:gray>]</span> <span style=color:green>DIRECTORY</span> <span style=color:green>TEMPLATE</span> <span style=color:green>QUERY</span>


===Arguments===
===Arguments===


* <code><span style=color:green>DIRECTORY</span></code> is the directory containing all the input files. The output files will also be saved to this directory.  
* <code><span style=color:green>DIRECTORY</span></code> is the directory containing all the input files. The output files will also be saved to this directory.  
* <code><span style=color:green>TEMPLATE</span></code> describes the template protein domain in one of the following formats: <code><span style=color:green>PDB</span></code> or <code><span style=color:green>PDB</span>,<span style=color:green>CHAIN</span></code> or <code><span style=color:green>PDB</span>,<span style=color:green>CHAIN</span>,<span style=color:green>RANGES</span></code>. The whole argument must be written without spaces. Examples:
* <code><span style=color:green>TEMPLATE</span></code> describes the template protein domain in one of the following formats: <code><span style=color:green>PDB</span></code> or <code><span style=color:green>PDB</span>,<span style=color:green>CHAIN</span></code> or <code><span style=color:green>PDB</span>,<span style=color:gre
** <code>1og2</code> (structure 1og2, chain A by default)
** <code>1og2,B</code> (chain B)
** <code>1og2,B,100:400</code> (residues 100–400 of the chain B)
** <code>1og2,B,:400</code> (residues up to 400 of the chain B)
** <code>1h9r,A,123:183,252:261</code> (residues 123–183 and 252–261 of the chain A)
* <code><span style=color:green>QUERY</span></code> describes the query protein domain and uses the same format as <code><span style=color:green>TEMPLATE</span></code>.
 
===Options===


There is a range of options which can be used to modify the behaviour of SecStrAnnotator.  The most important option is:
There is a range of options which can be used to modify the behaviour of SecStrAnnotator.  The most important option is:
* <code>--help</code>  Prints the help message, which includes the description of all other options.
* <code>--help</code>  Prints the help message, which includes the description of all other options.


===Input files===
===Input files===
Line 34: Line 29:
* <code><span style=color:green>DIRECTORY</span>/<span style=color:green>TEMPLATEPDB</span>-template.sses.json</code>  – annotation of the template domain
* <code><span style=color:green>DIRECTORY</span>/<span style=color:green>TEMPLATEPDB</span>-template.sses.json</code>  – annotation of the template domain
* <code><span style=color:green>DIRECTORY</span>/<span style=color:green>QUERYPDB</span>.pdb</code>  – structure of the query protein
* <code><span style=color:green>DIRECTORY</span>/<span style=color:green>QUERYPDB</span>.pdb</code>  – structure of the query protein


===Output files===
===Output files===
Line 41: Line 37:
* <code><span style=color:green>DIRECTORY</span>/<span style=color:green>QUERYPDB</span>-annotated.sses.json</code>
* <code><span style=color:green>DIRECTORY</span>/<span style=color:green>QUERYPDB</span>-annotated.sses.json</code>
* <code><span style=color:green>DIRECTORY</span>/<span style=color:green>QUERYPDB</span>-annotated.pse</code> (only when executed with <code>--session</code> option)
* <code><span style=color:green>DIRECTORY</span>/<span style=color:green>QUERYPDB</span>-annotated.pse</code> (only when executed with <code>--session</code> option)


===Auxiliary files and programs===
===Auxiliary files and programs===

Revision as of 00:16, 29 April 2018

SecStrAnnotator finds annotation for a query protein Q, based on the template protein T. Thus, the input consists of the structure of T, structure of Q, and annotation of T.

The annotation algorithm consists of three major steps. The first step is structural alignment and superimposition of the query protein with the template protein, so the corresponding parts of the two proteins are located close to each other. In the second step, secondary structure assignment (SSA) is performed – SSEs are detected in the query protein Q. The third step is called matching – the algorithm will match the template SSEs to the query SSEs and for each annotated SSE in T it will select the corresponding SSE in Q.


Execution

SecStrAnnotator is executed from command line and can run on both Windows and Unix. However, on Unix system it must be run using Mono.

Windows:

SecStrAnnotator.exe [OPTIONS] DIRECTORY TEMPLATE QUERY

Unix:

mono SecStrAnnotator.exe [OPTIONS] DIRECTORY TEMPLATE QUERY


Arguments

  • DIRECTORY is the directory containing all the input files. The output files will also be saved to this directory.
  • TEMPLATE describes the template protein domain in one of the following formats: PDB or PDB,CHAIN or PDB,<span style=color:gre

There is a range of options which can be used to modify the behaviour of SecStrAnnotator. The most important option is:

  • --help Prints the help message, which includes the description of all other options.


Input files

  • DIRECTORY/TEMPLATEPDB.pdb – structure of the template protein
  • DIRECTORY/TEMPLATEPDB-template.sses.json – annotation of the template domain
  • DIRECTORY/QUERYPDB.pdb – structure of the query protein


Output files

  • DIRECTORY/QUERYPDB-aligned.pdb
  • DIRECTORY/QUERYPDB-detected.sses.json
  • DIRECTORY/QUERYPDB-annotated.sses.json
  • DIRECTORY/QUERYPDB-annotated.pse (only when executed with --session option)


Auxiliary files and programs

SecStrAnnotator has dependencies on other programs (PyMOL, optionally DSSP) and scripts. These auxiliary files need to be available in the system, and there location must be specified in the configuration file SecStrAnnotator_config.json. The configuration file itself must be in the same directory as SecStrAnnotator.exe. The default content of the configuration file is:

{
	"PymolExecutable":    "pymol",
	"DsspExecutable":     "./dssp",
	"PymolScriptAlign":   "./script_align.py",
	"PymolScriptSession": "./script_session.py"
}

which assumes that pymol is installed and can be run directly (from $PATH) and that the other files are present in the same directory as SecStrAnnotator.exe.

On Windows, the location of PyMOL executable must be manually inserted into the modification file (it is usually C:\Program Files\PyMOL\PyMOL\PyMOL.exe, but can be different):

{
	"PymolExecutable":    "C:\\Program Files\\PyMOL\\PyMOL\\PyMOL.exe",
	"DsspExecutable":     "./dssp",
	"PymolScriptAlign":   "./script_align.py",
	"PymolScriptSession": "./script_session.py"
}