SecStrAnnotator:OneToOne

This page is about SecStrAnnotator 2.3 (the page for SecStrAnnotator 1.0 is here).

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.

Sometimes a single protein consists of several domains. In such cases, T and Q do not refer to the whole protein but only to one domain.

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.

Dependencies

.NET 6.0 runtime

Download and install from the official .NET website. (For SecStrAnnotator 2.0–2.2, use .NET Core 3.0 or .NET Core 3.1)

PyMOL

PyMOL is used by SecStrAnnotator for structural alignment and visualization. It can be downloaded from the PyMOL website. In Ubuntu Linux it can also be installed by running sudo apt install pymol.

(DSSP)

Only needed if using DSSP secondary structure assignment method (--ssa dssp). In Ubuntu Linux it can be installed by running sudo apt install dssp.

Execution

SecStrAnnotator is executed from command line:

dotnet SecStrAnnotator.dll [OPTIONS] DIRECTORY TEMPLATE QUERY

Example of a call:

 dotnet SecStrAnnotator.dll --help                                                                          # Show help

 dotnet SecStrAnnotator.dll --onlyssa my_data_directory 1tqn,A,7:478                                        # Only detect SSEs

 dotnet SecStrAnnotator.dll my_data_directory 2nnj,A 1tqn,A,7:478                                           # Detect and annotate SSEs

 dotnet SecStrAnnotator.dll my_data_directory 2nnj,A 1tqn,A,7:478 --align cealign --matching mom --session  # Detect and annotate SSEs

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,CHAIN,RANGES. The whole argument must be written without spaces. Examples:
- 1og2 (structure 1og2, chain A by default)
- 1og2,B (chain B)
- 1og2,B,100:400 (residues 100–400 of the chain B)
- 1og2,B,:400 (residues up to 400 of the chain B)
- 1h9r,A,123:183,252:261 (residues 123–183 and 252–261 of the chain A)
QUERY describes the query protein domain and uses the same format as TEMPLATE.

Keep in mind that the chains and residues are numbered according to the label_* numbering scheme in mmCIF file format (i.e. chain identifier is label_asym_id, residue number is label_seq_id).

Options

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 the other options.

Input files

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

Output files

DIRECTORY/QUERYPDB-aligned.cif – structure of the query protein after superimposition on the template protein
DIRECTORY/QUERYPDB-detected.sses.json – secondary structure assignment of the query protein, i.e. all detected SSEs
DIRECTORY/QUERYPDB-annotated.sses.json – annotated SSEs in the query protein
DIRECTORY/QUERYPDB-annotated.pse – PyMOL session with the visualization of the resulting annotation (only when executed with --session option)
Additional output files and more detailed .sses.json files are produced when executed with --verbose 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.dll. The default content of the configuration file is:

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

which assumes that pymol is installed and can be run directly (from $PATH) and that the other files are present in subdirectory scripts.

On Windows, you must find the location of PyMOL executable and insert it into the configuration file.

It will be probably some impossible-to-find file like C:\Program Files\PyMOL\PyMOL\PyMOL.exe or C:\ProgramData\PyMOL\Scripts\pymol.exe (or C:/Users/Adam/miniconda3/Scripts/pymol.exe if you installed PyMOL via conda).
To make it more fun, ProgramData is a hidden directory, which is by default invisible in File Explorer.
We're looking for PyMOL.exe, not PyMOLWin.exe. PyMOLWin.exe will run asynchronously and it will probably not work.
Note that \ is a special escaping character in JSON. Therefore use / or \\ instead of \.

{
	"PymolExecutable":    "C:/ProgramData/PyMOL/Scripts/pymol.exe",
	"PymolScriptAlign":   "./scripts/script_align.py",
	"PymolScriptSession": "./scripts/script_session.py",
	"DsspExecutable":     "./dssp.exe"
}

Annotation file format

All files with extension .sses.json are in SecStrAnnotator annotation format. A short example of this format:

{
  "1tqn": {
    "comment": "This is a demonstration of the annotation format. It shows a few SSEs selected from the real annotation of 1tqn.",
    "secondary_structure_elements": [
      { "label": "A", "chain_id": "A", "start": 36, "end": 47, "type": "H", "sequence": "FCMFDMECHKKY" },
      { "label": "B", "chain_id": "A", "start": 66, "end": 76, "type": "h", "sequence": "PDMIKTVLVKE" },
      { "label": "1-1", "chain_id": "A", "start": 50, "end": 55, "type": "E", "sheet_id": 1, "sequence": "VWGFYD" },
      { "label": "1-2", "chain_id": "A", "start": 58, "end": 63, "type": "E", "sheet_id": 1, "sequence": "QPVLAI" },
      { "label": "1-3", "chain_id": "A", "start": 372, "end": 375, "type": "E", "sheet_id": 1, "sequence": "VVMI" }
    ],
    "beta_connectivity": [
      [ "1-1", "1-2", -1 ],
      [ "1-2", "1-3", 1 ]
    ]
  }
}

The example describes two helices, named A and B, and a β-sheet consisting of three strands, named 1-1, 1-2, and 1-3. Strands 1-1 and 1-2 are connected by an anti-parallel β-ladder, strands 1-2 and 1-3 by a parallel β-ladder. All the SSEs are located on chain A of structure 1tqn.

Back to the main page