annotate mayachemtool/mayachemtools/docs/scripts/txt/InfoPDBFiles.txt @ 0:a4a2ad5a214e draft default tip

Uploaded
author deepakjadmin
date Thu, 05 Nov 2015 02:37:56 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
2 InfoPDBFiles.pl - List information about PDB files
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
3
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
5 InfoPDBFiles.pl PDBFile(s) PDB(s)...
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
6
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
7 InfoPDBFiles.pl [-a, --all] [-b, --BoundingBox] [-c, --count
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
8 "RecordType, [RecordType,...]" | All] [--chains] [-d, --detail
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
9 infolevel] [-e, --experiment] [-f, --frequency] [-h, --help] [--header]
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
10 [m, --MasterCheck] [--residues] [--ResiduesMode InChains | All | Both]
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
11 [--ResidueNumbers] [-w, --WorkingDir dirname] PDBFile(s)...
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
12
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
13 DESCRIPTION
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
14 List information about contents of *PDBFile(s)*: number of each record
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
15 type, number of chains, count and percent distribution of residues in
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
16 each chain, bounding box and so on. Multiple PDBFile names are separated
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
17 by spaces. The valid file extension is *.pdb*. All other file name
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
18 extensions are ignored during the wild card expansion. All the PDB files
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
19 in a current directory can be specified either by **.pdb* or the current
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
20 directory name.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
21
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
22 In PDB files containing data for multiple models, all ATOM/HETAM records
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
23 for chains after the first model are ignored.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
24
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
25 OPTIONS
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
26 -a, --all
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
27 List all the available information.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
28
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
29 -b, --BoundingBox
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
30 List min/max XYZ coordiates of ATOM/HETATM records.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
31
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
32 -c, --count *RecordType,[RecordType,...]|All*
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
33 Types of PDB records to count in *PDBFile(s)*. You can specify a
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
34 list of any valid PDB record type or count all record types found in
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
35 the files. Possible values: Comma delimited list of valid
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
36 *RecordTypes* or *All*. Default: *ATOM,HETATM*. And this is also
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
37 default behavior.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
38
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
39 The list of valid PDB record types includes: *HEADER, OBSLTE, TITLE,
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
40 CAVEAT, COMPND, SOURCE, KEYWDS, EXPDTA, AUTHOR, REVDAT, SPRSDE, JRN,
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
41 REMARK, DBRE, SEQADV, SEQRES, MODRES, HET, HETNAM, HETSYN, FORMUL,
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
42 HELIX, SHEET, TURN, SSBOND, LINK, HYDBND, SLTBRG, CISPEP, SITE,
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
43 CRYST1, ORIGX1, ORIGX2, ORIGX3, SCALE1, SCALE2, SCALE3, MTRIX1
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
44 MTRIX2 MTRIX3, TVECT, MODEL, ATOM, SIGATM, ANISOU, SIGUIJ, TER,
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
45 HETATM, ENDMDL, CONECT, MASTER, END*.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
46
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
47 --chains
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
48 Count number of chains.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
49
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
50 -d, --detail *infolevel*
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
51 Level of information to print about PDB during various options.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
52 Default: *1*. Possible values: *1, 2 or 3*.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
53
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
54 -e, --experiment
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
55 List experimental technique information along with any applicable
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
56 resolution.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
57
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
58 -f, --frequency
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
59 List distribution of residues: report count and percent of residues
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
60 in individual chains and across all the chains, or for all the
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
61 residues in the file. The value of option --residuesmode determines
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
62 how residues are counted and what is listed. The list is sorted by
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
63 frequency in descending order. By default, only residue count values
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
64 are reported. To list percent distribution of residues, specify -d,
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
65 --detail value of *2* or higher.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
66
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
67 -h, --help
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
68 Print this help message.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
69
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
70 --header
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
71 List header information.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
72
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
73 m, --MasterCheck
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
74 Check master record by explicitly counting the number of REMARK,
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
75 HET, HELIX, SHEET, TURN, SITE, ORIGX, SCALE, MTRIX, ATOM, HETATM,
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
76 TER, CONECT and SEQRES records and comparing their values against
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
77 contents of master record.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
78
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
79 --residues
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
80 Count residues in *PDBFile(s)*. This is also default behavior.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
81
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
82 By default, only residue count values are reported. To list percent
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
83 distribution of residues, specify -d, --detail value of *2* or
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
84 higher.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
85
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
86 --ResiduesMode <InChains | All | Both>
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
87 Specify how to count residues in *PDBFile(s)*: Count residue in each
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
88 chain and across all the chains, list count iof all the residues in
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
89 the file, or list both. Possible values: *InChains, All, or Both*.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
90 Default: *Both*.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
91
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
92 --ResidueNumbers
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
93 List information about ATOM residue numbers in each chain before TER
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
94 record: start and end residue number; gaps in residue numbers
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
95 corresponding to non-sequential residue numbers; residue numbers not
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
96 in ascending order.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
97
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
98 -w, --WorkingDir *dirname*
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
99 Location of working directory. Default: current directory.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
100
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
101 EXAMPLES
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
102 To list total number of records and number of chain(s) residues in PDB
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
103 files, type:
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
104
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
105 % InfoPDBFiles.pl Sample1.pdb
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
106 % InfoPDBFiles.pl Sample2.pdb
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
107
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
108 To list all available information for PDB file Sample2.pdb, type:
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
109
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
110 % InfoPDBFiles.pl -a Sample2.pdb
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
111
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
112 To list all available information for PDB file Sample2.pdb with all
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
113 available details, type:
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
114
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
115 % InfoPDBFiles.pl -a -d Sample2.pdb
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
116
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
117 To count ATOM and HETATM records in Sample2.pdb file, type:
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
118
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
119 % InfoPDBFiles.pl -c "ATOM,HETATM" Sample2.pdb
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
120
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
121 To list distribution of residues in chains across the whole PDB file
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
122 Sample2.pdb along with percent distribution, type
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
123
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
124 % InfoPDBFiles.pl --frequency -d 2 Sample2.pdb
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
125
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
126 To list distribution of residues only across chains in PDB file
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
127 Sample2.pdb along with percent distribution, type
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
128
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
129 % InfoPDBFiles.pl --frequency -d 2 --ResiduesMode InChains Sample2.pdb
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
130
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
131 To list min/max coordinates of the bounding box which encompasses the
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
132 structure in Sample1.pdb file, type:
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
133
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
134 % InfoPDBFiles.pl -b Sample1.pdb
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
135
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
136 AUTHOR
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
137 Manish Sud <msud@san.rr.com>
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
138
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
139 SEE ALSO
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
140 ExtractFromPDBFiles.pl, InfoAminoAcids.pl, InfoNucleicAcids.pl,
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
141 InfoSequenceFiles.pl, ModifyPDBFiles.pl
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
142
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
143 COPYRIGHT
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
144 Copyright (C) 2015 Manish Sud. All rights reserved.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
145
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
146 This file is part of MayaChemTools.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
147
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
148 MayaChemTools is free software; you can redistribute it and/or modify it
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
149 under the terms of the GNU Lesser General Public License as published by
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
150 the Free Software Foundation; either version 3 of the License, or (at
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
151 your option) any later version.
a4a2ad5a214e Uploaded
deepakjadmin
parents:
diff changeset
152