Jump to content

MotiveValidator:MotifExtractor Help: Difference between revisions

From WebChemistry Wiki
Created page with "MotifExtractor is a simple automated script for extracting the motifs of interest from biomolecule structure files. You may define one or more motifs to be extracted from a se..."
 
 
(3 intermediate revisions by the same user not shown)
Line 13: Line 13:


== Output ==
== Output ==
A .zip archive containing
A folder containing:
* Folders with motifs in PDB format.
* Information about the progress of the computation (<code>log.txt</code>, <code>status.json</code>).
* CSV files with list of motifs and their unique identifier (motif index).
* ZIP file <code>result\motives.zip</code> containing:
:* A folder with motifs in PDB format (one for each motif specified in the input).
:* CSV files with detailed information about the found motifs.
* JSON file <code>result\summary.json</code> with the number of found motifs.


== Execution ==
== Execution ==
* Windows
* Windows
: Open the utility cmd, go to the location where you unzipped MotifExtractor, and, after you have edited the .json file according to your needs, run MotifExtractor as "MotiveQuery.exe path_to_output motifs.json" (without the "). For example:  
: Open the utility cmd, go to the location where you unzipped MotifExtractor, and, after you have edited the .json file according to your needs, run MotifExtractor as <code>MotiveQuery.exe path_to_output motifs.json</code>. For example:  
<pre>MotiveQuery c:\data\nag_motifs motifs.json</pre>
<pre>MotiveQuery c:\data\nag_motifs motifs.json</pre>


* Linux and MacOS
* Linux and MacOS
: Open a terminal, go to the location where you unzipped MotifExtractor, and, after you have edited the .json file according to your needs, run MotifExtractor as "mono MotiveQuery.exe path_to_output motifs.json" (without the ").
: Open a terminal, go to the location where you unzipped MotifExtractor, and, after you have edited the .json file according to your needs, run MotifExtractor as <code>mono MotiveQuery.exe path_to_output motifs.json</code>.

Latest revision as of 15:26, 11 June 2014

MotifExtractor is a simple automated script for extracting the motifs of interest from biomolecule structure files. You may define one or more motifs to be extracted from a set of biomolecules stored in PDB format.

Requirements

[edit]
  • Windows: .NET 4.5 or newer
  • Linux and MacOS: MONO 3.2.3 or newer

Input

[edit]
  • A folder with a set of biomolecules in PDB format.
  • A .json file with settings, defining the motif(s) to be extracted. The key parameters of the .json file are encoded in attributes, that you will need to edit depending on what you want to extract and from where:
  1. Location of the folder with biomolecules - attribute "InputFolders". When writing the path to your folder, note that backslashes must be escaped (so C:\Data\pdb should be written as C:\\Data\\pdb), or forward slash can be used (C:/Data/pdb).
  2. Name of query residue - attributes "Id", "Name", and "Residues". Write the 3-letter code for the residue of interest.

Output

[edit]

A folder containing:

  • Information about the progress of the computation (log.txt, status.json).
  • ZIP file result\motives.zip containing:
  • A folder with motifs in PDB format (one for each motif specified in the input).
  • CSV files with detailed information about the found motifs.
  • JSON file result\summary.json with the number of found motifs.

Execution

[edit]
  • Windows
Open the utility cmd, go to the location where you unzipped MotifExtractor, and, after you have edited the .json file according to your needs, run MotifExtractor as MotiveQuery.exe path_to_output motifs.json. For example:
MotiveQuery c:\data\nag_motifs motifs.json
  • Linux and MacOS
Open a terminal, go to the location where you unzipped MotifExtractor, and, after you have edited the .json file according to your needs, run MotifExtractor as mono MotiveQuery.exe path_to_output motifs.json.