MMTSB
Tool Set Documentation

Difference between revisions of "getprop.pl"

From MMTSB
Jump to: navigation, search
(cZYbfBvFP)
 
(37 intermediate revisions by 3 users not shown)
Line 1: Line 1:
dummy
+
__NOTOC__
 +
== Usage ==
 +
 
 +
<mmtsbToolUsage cmd="getprop.pl"></mmtsbToolUsage>
 +
 
 +
== Description ==
 +
 
 +
This script is used for extracting structural properties for
 +
a set of structures in an ensemble. It requires a tag as argument to
 +
identify the structure set and either one of the options
 +
<B>-show</B> or <B>-prop</B>.<BR>
 +
 
 +
The option <B>-prop</B> is used with a comma-separated list of
 +
property tags to extract the corresponding data written
 +
to standard output. The output consists of data columns
 +
in the same order as the tags are given in the list argument.
 +
The option <B>-show</B> is available to print the tags for
 +
all available properties.<BR>
 +
 
 +
The following tags are commonly available:<BR>
 +
<TABLE CELLPADDING=1 CELLSPACING=1>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>etot</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>total energy</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>eelec</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>electrostatic energy</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>evdw</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>van der Waals energy</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>egb</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>Generalized Born energy</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>esasa</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>Hydrophobic solvation energy</FONT></TD>
 +
</TR>
 +
<TR><TD></TD></TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>rgyr</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>radius of gyration</FONT></TD>
 +
</TR>
 +
<TR><TD></TD></TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>rmsdall</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>total RMSD from native</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>rmsdca</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>C-alpha RMSD from native</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>rmsdback</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>backbone RMSD from native</FONT></TD>
 +
</TR>
 +
<TR><TD></TD></TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>rmsdpol</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>polar RMS distance from center</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>rmsdhyd</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>hydrophobic RMS distance from center</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>rmsdchg</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>charged RMS distance from center</FONT></TD>
 +
</TR>
 +
<TR><TD></TD></TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>rmsdphi</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>phi dihed. RMSD from native</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>rmsdpsi</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>psi dihed. RMSD from native</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>rmsdchi1</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>chi1 dihed. RMSD from native</FONT></TD>
 +
</TR>
 +
<TR><TD></TD></TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>pphi</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>percent correct phi</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>ppsi</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>percent correct psi</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>pchi1</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>percent correct chi1</FONT></TD>
 +
</TR>
 +
<TR><TD></TD></TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>cont</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>fraction of native contacts</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>rho</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>fraction of native contacts</FONT></TD>
 +
</TR>
 +
<TR>
 +
  <TD><FONT FACE=courier SIZE=3>gdtts</FONT></TD>
 +
  <TD><FONT FACE=sans-serif,ARIAL,HELVETICA SIZE=3>GDT similarity from native</FONT></TD>
 +
</TR>
 +
</TABLE>
 +
<BR>
 +
This script only extracts data that has been previously
 +
calculated. In order to calculate structural properties for
 +
a whole ensemble see [[calcprop.pl]]. Properties
 +
may be set from external data with [[setprop.pl]].
 +
<BR>
 +
 
 +
If the option <B>-score</B> is given a single score is calculated
 +
from the property values of all ensemble structures and written
 +
out instead of the whole list. The most common use would
 +
be to calculate simple averages with <B>-score avg</B>.
 +
Values that lie outside a given multiple
 +
of the standard deviation can be excluded as in
 +
[[bestcluster.pl]] by using <font color=#508060>avglow</font> or
 +
<font color=#508060>avgcent</font> as key words instead of <font color=#508060>avg</font>.
 +
The option <B>-limstd</B> is available to modify the value of
 +
the multiple used in this case.<BR>
 +
 
 +
The option <B>-cluster</B> is available to extract only data for
 +
structures in a certain cluster. Clusters can be calculated with
 +
[[enscluster.pl]]. If cluster information is only
 +
available for a different tag in the same ensemble the tag can
 +
be given with <B>-ctag</B> so that the corresponding cluster
 +
data is used instead. The <B>-cluster</B>
 +
option may be combined with <B>-score</B> to obtain a score for
 +
conformations in a given cluster.
 +
 
 +
== Options ==
 +
 
 +
; -help : usage information
 +
; -dir directory : data directory
 +
; -show : print out a list of available properties
 +
; -prop prop[+prop][,...] : list of properties for which data is requested
 +
; -cluster tag : limit output to given cluster
 +
; -ctag alttag : read clustering data from <TT>alttag.clusters</TT>
 +
; -score avg|avglow|avgcent|median : calculate averages from selected properties
 +
; -limstd multiple : multiple of standard deviation for excluding structures when calculating averages (with -score avglow|avgcent)
 +
 
 +
== Examples ==
 +
 
 +
<mmtsbToolExample cmd="getprop.pl" set="/apps/mmtsb/bench/getprop.pl-test/test1"></mmtsbToolExample>
 +
 
 +
<mmtsbToolExample cmd="getprop.pl" set="/apps/mmtsb/bench/getprop.pl-test/test2"></mmtsbToolExample>
 +
 
 +
<mmtsbToolExample cmd="getprop.pl" set="/apps/mmtsb/bench/getprop.pl-test/test3"></mmtsbToolExample>
 +
 
 +
<mmtsbToolExample cmd="getprop.pl" set="/apps/mmtsb/bench/getprop.pl-test/test4"></mmtsbToolExample>
 +
 
 +
<mmtsbToolExample cmd="getprop.pl" set="/apps/mmtsb/bench/getprop.pl-test/test5"></mmtsbToolExample>

Latest revision as of 14:25, 30 July 2009

Usage

usage:   getprop.pl [options] tag
options: [-dir datadir]
         [-show]
         [-prop prop[+prop][,prop]]
         [-cluster tag] [-ctag tag]
         [-score avg|avglow|avgcent|median]
         [-limit low|high|cent]
         [-liminx index]
         [-limstd multiple]

Show source


Description

This script is used for extracting structural properties for a set of structures in an ensemble. It requires a tag as argument to identify the structure set and either one of the options -show or -prop.

The option -prop is used with a comma-separated list of property tags to extract the corresponding data written to standard output. The output consists of data columns in the same order as the tags are given in the list argument. The option -show is available to print the tags for all available properties.

The following tags are commonly available:

etot total energy
eelec electrostatic energy
evdw van der Waals energy
egb Generalized Born energy
esasa Hydrophobic solvation energy
rgyr radius of gyration
rmsdall total RMSD from native
rmsdca C-alpha RMSD from native
rmsdback backbone RMSD from native
rmsdpol polar RMS distance from center
rmsdhyd hydrophobic RMS distance from center
rmsdchg charged RMS distance from center
rmsdphi phi dihed. RMSD from native
rmsdpsi psi dihed. RMSD from native
rmsdchi1 chi1 dihed. RMSD from native
pphi percent correct phi
ppsi percent correct psi
pchi1 percent correct chi1
cont fraction of native contacts
rho fraction of native contacts
gdtts GDT similarity from native


This script only extracts data that has been previously calculated. In order to calculate structural properties for a whole ensemble see calcprop.pl. Properties may be set from external data with setprop.pl.

If the option -score is given a single score is calculated from the property values of all ensemble structures and written out instead of the whole list. The most common use would be to calculate simple averages with -score avg. Values that lie outside a given multiple of the standard deviation can be excluded as in bestcluster.pl by using avglow or avgcent as key words instead of avg. The option -limstd is available to modify the value of the multiple used in this case.

The option -cluster is available to extract only data for structures in a certain cluster. Clusters can be calculated with enscluster.pl. If cluster information is only available for a different tag in the same ensemble the tag can be given with -ctag so that the corresponding cluster data is used instead. The -cluster option may be combined with -score to obtain a score for conformations in a given cluster.

Options

-help 
usage information
-dir directory 
data directory
-show 
print out a list of available properties
-prop prop[+prop][,...] 
list of properties for which data is requested
-cluster tag 
limit output to given cluster
-ctag alttag 
read clustering data from alttag.clusters
-score avg|avglow|avgcent|median 
calculate averages from selected properties
-limstd multiple 
multiple of standard deviation for excluding structures when calculating averages (with -score avglow|avgcent)

Examples

getprop.pl -dir data -show sample
prints out the available property tags for structures associated with the sample tag in the ensemble under the data directory

available properties are:
 cont etot gdtts pchi1
 pphi ppsi rgyr rho
 rmsdall rmsdback rmsdca rmsdchg
 rmsdchi1 rmsdhyd rmsdphi rmsdpol
 rmsdpsi


getprop.pl -dir data -prop rmsdall,cont sample
extracts total RMSD (rmsdall) and fraction of native contacts (cont) for the sample structures in the ensemble under the data directory

1 13.483227 0.041667 
2 2.994885 0.583333 
3 9.699920 0.125000 
4 9.598882 0.041667 
5 9.066114 0.083333 
6 4.274226 0.500000 
7 2.733985 0.708333 
8 2.774350 0.541667 
9 2.788660 0.708333 


getprop.pl -dir data -prop rgyr,cont -cluster t.2 sample
extracts the radius of gyration (rgyr) and fraction of native contacts (cont) for structures in the cluster t.2 associated with the sample tag.

2 9.796450 0.416667 
4 9.306858 0.625000 
5 9.505148 0.708333 
6 9.646953 0.458333 
7 10.014612 0.208333 
9 9.732428 0.583333 
10 12.625645 0.125000 
13 9.622869 0.500000 
14 9.159078 0.708333 
15 9.735043 0.541667 

...


getprop.pl -dir data -prop rmsdall,cont -score avg sample
calculates average values for total RMSD and fraction of native contacts

 6.379361 0.370370


getprop.pl -dir data -prop rgyr,cont -score median -cluster t.2 sample
determines median values for the radius of gyration (rgyr) and fraction of native contacts (cont) for structures in the cluster t.2 associated with the sample tag.

 9.735043 0.416667