annotate docs/scripts/txt/InfoPDBFiles.txt @ 0:4816e4a8ae95 draft default tip

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