annotate mayachemtools/docs/scripts/man1/ModifyPDBFiles.1 @ 9:ab29fa5c8c1f draft default tip

Uploaded
author deepakjadmin
date Thu, 15 Dec 2016 14:18:03 -0500
parents 73ae111cf86f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 .\" Standard preamble:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 .\" ========================================================================
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 .de Sp \" Vertical space (when we can't use .PP)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 .if t .sp .5v
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 .if n .sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 .de Vb \" Begin verbatim text
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 .ft CW
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 .nf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 .ne \\$1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 .de Ve \" End verbatim text
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 .ft R
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 .fi
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 .\" Set up some character translations and predefined strings. \*(-- will
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 .\" nothing in troff, for use with C<>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 .tr \(*W-
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 .ie n \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 . ds -- \(*W-
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 . ds PI pi
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 . ds L" ""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 . ds R" ""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 . ds C` ""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 . ds C' ""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 'br\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 .el\{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 . ds -- \|\(em\|
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 . ds PI \(*p
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 . ds L" ``
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 . ds R" ''
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 'br\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 .ie \n(.g .ds Aq \(aq
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 .el .ds Aq '
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 .\" If the F register is turned on, we'll generate index entries on stderr for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 .\" output yourself in some meaningful fashion.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 .ie \nF \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 . de IX
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 . tm Index:\\$1\t\\n%\t"\\$2"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 . nr % 0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 . rr F
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 .el \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 . de IX
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 . \" fudge factors for nroff and troff
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 .if n \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 . ds #H 0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 . ds #V .8m
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 . ds #F .3m
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 . ds #[ \f1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 . ds #] \fP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 .if t \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 . ds #V .6m
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 . ds #F 0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 . ds #[ \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 . ds #] \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 . \" simple accents for nroff and troff
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 .if n \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 . ds ' \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 . ds ` \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 . ds ^ \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 . ds , \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 . ds ~ ~
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 . ds /
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 .if t \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 . \" troff and (daisy-wheel) nroff accents
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 .ds ae a\h'-(\w'a'u*4/10)'e
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 .ds Ae A\h'-(\w'A'u*4/10)'E
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 . \" corrections for vroff
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 . \" for low resolution devices (crt and lpr)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 .if \n(.H>23 .if \n(.V>19 \
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 . ds : e
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 . ds 8 ss
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 . ds o a
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 . ds d- d\h'-1'\(ga
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 . ds D- D\h'-1'\(hy
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 . ds th \o'bp'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 . ds Th \o'LP'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 . ds ae ae
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 . ds Ae AE
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 .rm #[ #] #H #V #F C
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 .\" ========================================================================
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126 .IX Title "MODIFYPDBFILES 1"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 .TH MODIFYPDBFILES 1 "2015-03-29" "perl v5.14.2" "MayaChemTools"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129 .\" way too many mistakes in technical documents.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 .if n .ad l
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 .nh
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 .SH "NAME"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 ModifyPDBFiles.pl \- Modify data in PDBFile(s)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 .SH "SYNOPSIS"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135 .IX Header "SYNOPSIS"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 ModifyPDBFiles.pl PDBFile(s)...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 ModifyPDBFiles.pl [\fB\-a, \-\-AtomNumberStart\fR number] [\fB\-c, \-\-ChainIDStart\fR character]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 [\fB\-\-ChainIDRenameEmpty\fR yes | no] [\fB\-h, \-\-help\fR] [\fB\-k, \-\-KeepOldRecords\fR yes | no]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140 [\fB\-m, \-\-mode \fR RenumberAtoms | RenumberResidues | RenumberWaters | RenameChainIDs]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 [\fB\-\-ModifyHeader\fR yes | no] [\fB\-o, \-\-overwrite\fR] [\fB\-\-ResidueNumberMode\fR Sequential | PerChain]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 [\fB\-\-ResidueNumberStart\fR number] [\fB\-\-ResidueNumberHetatmMode\fR automatic | specify]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 [\fB\-\-ResidueNumberStarHetatm\fR number] [\fB\-r, \-\-root\fR rootname]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 [\fB\-\-WaterResidueNames\fR Automatic | \*(L"ResidueName, [ResidueName,...]\*(R"] [\fB\-\-WaterResidueStart\fR number]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145 [\fB\-w, \-\-WorkingDir\fR dirname] PDBFile(s)...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146 .SH "DESCRIPTION"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
147 .IX Header "DESCRIPTION"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
148 Modify data in \fIPDBFile(s)\fR: renumber atoms, residues, and water residues or assign new
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
149 chain IDs. Multiple PDBFile names are separated by spaces. The valid file extension is \fI.pdb\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
150 All other file name extensions are ignored during the wild card expansion. All the \s-1PDB\s0 files
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
151 in a current directory can be specified either by \fI*.pdb\fR or the current directory name.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
152 .SH "OPTIONS"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
153 .IX Header "OPTIONS"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
154 .IP "\fB\-a, \-\-AtomNumberStart\fR \fInumber\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
155 .IX Item "-a, --AtomNumberStart number"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
156 Starting atom number to use during \fIRenumberAtoms\fR value of \fB\-m, \-\-mode\fR option. Default: \fI1\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
157 Valid values: positive integers.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
158 .IP "\fB\-c, \-\-ChainIDStart\fR \fIcharacter\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
159 .IX Item "-c, --ChainIDStart character"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
160 A single character to use for starting IDs for chains during \fIRenameChainIDs\fR value of \fB\-m, \-\-mode\fR option.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
161 Default: \fIA\fR. Valid values: \fIA to Z\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
162 .IP "\fB\-\-ChainIDRenameEmpty\fR \fIYes | No\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
163 .IX Item "--ChainIDRenameEmpty Yes | No"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
164 Specify whether to rename empty chain IDs during \fIRenameChainIDs\fR \fB\-m, \-\-mode\fR value. By
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
165 default, \s-1ATOM\s0 and \s-1HETATM\s0 records with no chain IDs are left unchanged. Possible values:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
166 \&\fIyes | no\fR. Default: \fINo\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
167 .IP "\fB\-h, \-\-help\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
168 .IX Item "-h, --help"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
169 Print this help message.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
170 .IP "\fB\-k, \-\-KeepOldRecords\fR \fIyes | no\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
171 .IX Item "-k, --KeepOldRecords yes | no"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
172 Specify whether to transfer old non \s-1ATOM\s0 and \s-1HETATM\s0 records from input PDBFile(s) to new
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
173 PDBFile(s). By default, except for the \s-1HEADER\s0 record, all records other than \s-1ATOM/HETATM\s0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
174 are dropped during the generation of new \s-1PDB\s0 files. Possible values: \fIyes | no\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
175 Default: \fIno\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
176 .IP "\fB\-m, \-\-mode \fR \fIRenumberAtoms | RenumberResidues | RenumberWaters | RenameChainIDs\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
177 .IX Item "-m, --mode RenumberAtoms | RenumberResidues | RenumberWaters | RenameChainIDs"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
178 Specify how to modify \fIPDBFile(s)\fR. Possible values: \fIRenumberAtoms | RenumberResidues
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
179 | RenumberWaters | RenameChainIDs\fR. Default: \fIRenumberResidues\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
180 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
181 For \fIRenumberAtoms\fR mode, residue number in \s-1ATOM\s0 and \s-1HETATM\s0 records are reassigned
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
182 sequentially starting using value of \fB\-a, \-\-AtomNumberStart\fR option.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
183 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
184 For \fIRenumberResidues\fR mode, serial number in \s-1ATOM\s0 and \s-1HETATM\s0 records are reassigned
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
185 either sequentially or statring from specified values for \s-1ATOM\s0 and \s-1HETATM\s0 records in each
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
186 chain.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
187 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
188 For \fIRenumberWaters\fR mode, residue number for waters are reassigned starting from a specific
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
189 value.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
190 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
191 For \fIRenameChainIDs\fR mode, all the chain IDs are reassigned starting from a specific chain \s-1ID\s0.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
192 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
193 During the generation of new \s-1PDB\s0 files, unnecessary \s-1CONECT\s0 records are dropped.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
194 .IP "\fB\-\-ModifyHeader\fR \fIyes | no\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
195 .IX Item "--ModifyHeader yes | no"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
196 Specify whether to modify \s-1HEADER\s0 record during the generation of new \s-1PDB\s0 files
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
197 Possible values: \fIyes | no\fR. Default: \fIyes\fR. By defailt, Classification data is replaced
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
198 by \fIData modified using MayaChemTools\fR before writing out \s-1HEADER\s0 record.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
199 .IP "\fB\-o, \-\-overwrite\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
200 .IX Item "-o, --overwrite"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
201 Overwrite existing files
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
202 .IP "\fB\-\-ResidueNumberMode\fR \fISequential | PerChain\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
203 .IX Item "--ResidueNumberMode Sequential | PerChain"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
204 Specify how to renumber residues: renumber residues sequentially across all the chains
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
205 or start from the begining for each chain. Possible values: \fISequential | PerChain\fR. Default:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
206 \&\fIPerChain\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
207 .IP "\fB\-\-ResidueNumberStart\fR \fInumber\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
208 .IX Item "--ResidueNumberStart number"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
209 Starting residue number to use for \s-1ATOM\s0 records in chains. Default: \fI1\fR. Valid values
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
210 positive integers.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
211 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
212 For \fISequential\fR value of \fB\-\-ResidueNumberMode\fR option, residue numbers are
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
213 assigned sequentially across all the chains starting from the specified value.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
214 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
215 For \fIPerChain\fR value of \fB\-\-ResidueNumberMode\fR option, residue numbers are
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
216 starting again from the specified value for each chain.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
217 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
218 \&\s-1HETATM\s0 residues with in the chains are numbered using this value as well
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
219 .IP "\fB\-\-ResidueNumberHetatmMode\fR \fIautomatic | specify\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
220 .IX Item "--ResidueNumberHetatmMode automatic | specify"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
221 Specify how to start residue number for \s-1HETATM\s0 records: use the next sequential
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
222 residue number after the last residue number from \s-1ATOM\s0 records or start from a
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
223 specific residue number. Possible values: \fIautomatic | specify\fR. Default:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
224 \&\fIautomatic\fR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
225 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
226 For \fIautomatic\fR , residue number after highest residue number of \s-1ATOM\s0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
227 records is used as the starting residue number for \s-1HETATM\s0 records.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
228 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
229 For \fIspecify\fR, value of option \fB\-\-ResidueNumberStarHetatm\fR is used as the
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
230 starting residue number for \s-1HETATM\s0 records.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
231 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
232 This option along with \fB\-\-ResidueNumberStartHetatm\fR only applies to \s-1HETATM\s0 records
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
233 outside the chains.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
234 .IP "\fB\-\-ResidueNumberStartHetatm\fR \fInumber\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
235 .IX Item "--ResidueNumberStartHetatm number"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
236 Starting residue number to use for \s-1HETATM\s0 records. Default: \fI6000\fR. Valid values
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
237 positive integers.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
238 .IP "\fB\-r, \-\-root\fR \fIrootname\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
239 .IX Item "-r, --root rootname"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
240 New \s-1PDB\s0 and sequence file name is generated using the root: <Root><Mode>.<Ext>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
241 Default new file name: <PDBFileName><Mode>.pdb. This option is ignored for multiple
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
242 input files.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
243 .ie n .IP "\fB\-\-WaterResidueNames\fR \fIAutomatic | ""ResidueName,[ResidueName,...]""\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
244 .el .IP "\fB\-\-WaterResidueNames\fR \fIAutomatic | ``ResidueName,[ResidueName,...]''\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
245 .IX Item "--WaterResidueNames Automatic | ResidueName,[ResidueName,...]"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
246 Identification of water residues during \fIRenumberWaters\fR value of \fB\-m, \-\-mode\fR option. Possible
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
247 values: \fIAutomatic | \*(L"ResidueName,[ResidueName,...]\*(R"\fR. Default: \fIAutomatic\fR which corresponds
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
248 to \*(L"\s-1HOH\s0,WAT,H20\*(R". You can also specify a different comma delimited list of residue names
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
249 to use for water.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
250 .IP "\fB\-\-WaterResidueStart\fR \fInumber\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
251 .IX Item "--WaterResidueStart number"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
252 Starting water residue number to use during \fIRenumberWaters\fR \fB\-m, \-\-mode\fR value.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
253 Default: \fI8000\fR. Valid values: positive integers.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
254 .IP "\fB\-w, \-\-WorkingDir\fR \fIdirname\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
255 .IX Item "-w, --WorkingDir dirname"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
256 Location of working directory. Default: current directory.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
257 .SH "EXAMPLES"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
258 .IX Header "EXAMPLES"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
259 To renumber \s-1ATOM\s0 and \s-1HETATM\s0 residues starting from 1 for each chain with continuation to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
260 \&\s-1HETATM\s0 residues outside \s-1TER\s0 records in Sample2.pdb and generate
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
261 Sample2RenumberResidues.pdb file, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
262 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
263 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
264 \& % ModifyPDBFiles.pl Sample1.pdb
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
265 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
266 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
267 To renumber \s-1ATOM\s0 and \s-1HETATM\s0 residues sequentially across all chains starting from 1 with
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
268 continuation to \s-1HETATM\s0 residues outside \s-1TER\s0 records in Sample2.pdb and generate
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
269 Sample2RenumberResidues.pdb file, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
270 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
271 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
272 \& % ModifyPDBFiles.pl \-\-ResidueNumberMode Sequential \-o Sample1.pdb
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
273 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
274 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
275 To renumber \s-1ATOM\s0 and \s-1HETATM\s0 residues sequentially across all chains starting from 1 and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
276 \&\s-1HETATM\s0 residues outside \s-1TER\s0 records starting from 6000 in Sample2.pdb and generate
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
277 Sample2RenumberResidues.pdb file, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
278 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
279 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
280 \& % ModifyPDBFiles.pl \-\-ResidueNumberMode Sequential
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
281 \& \-\-ResidueNumberHetatmMode Specify \-o Sample1.pdb
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
282 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
283 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
284 To renumber \s-1ATOM\s0 and \s-1HETATM\s0 residues sequentially across all chains starting from 100 for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
285 \&\s-1ATOM/HETATM\s0 residues with in \s-1TER\s0 records and starting from 999 for \s-1HETATM\s0 residues
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
286 outside \s-1TER\s0 records in Sample2.pdb and generate Sample2RenumberResidues.pdb file, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
287 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
288 .Vb 3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
289 \& % ModifyPDBFiles.pl \-\-ResidueNumberMode Sequential
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
290 \& \-\-ResidueNumberHetatmMode Specify \-\-ResidueNumberStart 100
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
291 \& \-\-ResidueNumberStartHetatm 999 \-o Sample2.pdb
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
292 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
293 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
294 To renumber \s-1ATOM\s0 and \s-1HETATM\s0 residues from 100 for each chain and starting from 999 for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
295 \&\s-1HETATM\s0 residues outside \s-1TER\s0 records in Sample2.pdb and generate Sample2RenumberResidues.pdb
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
296 file, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
297 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
298 .Vb 3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
299 \& % ModifyPDBFiles.pl \-\-ResidueNumberMode PerChain
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
300 \& \-\-ResidueNumberHetatmMode Specify \-\-ResidueNumberStart 100
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
301 \& \-\-ResidueNumberStartHetatm 999 \-o Sample2.pdb
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
302 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
303 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
304 To renumber \s-1ATOM\s0 serial numbers sequentially starting from 100 in Sample1.pdb file and generate
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
305 Sample1RenumberAtoms.pdb file, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
306 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
307 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
308 \& % ModifyPDBFiles.pl \-m RenumberAtoms \-\-AtomNumberStart 100
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
309 \& \-o Sample1.pdb
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
310 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
311 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
312 To renumber water residues identified by \*(L"\s-1HOH\s0,WAT\*(R" starting from residue number 1000
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
313 in Sample2.pdb file and generate Sample2RenumberWaters.pdb file, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
314 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
315 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
316 \& % ModifyPDBFiles.pl \-m RenumberWaters \-\-WaterResidueNames "HOH,WAT"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
317 \& \-o \-\-WaterResidueStart 950 Sample2.pdb
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
318 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
319 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
320 To rename all chain IDs starting from A in Sample1.pdb file and generate
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
321 Sample1RenameChainIDs.pdb file, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
322 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
323 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
324 \& % ModifyPDBFiles.pl \-m RenameChainIDs \-o Sample1.pdb
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
325 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
326 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
327 To rename all chain IDs starting from B without assigning any chain IDs to \s-1ATOM/HETATOM\s0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
328 with no chain IDs in Sample2.pdb file and generate Sample2RenameChainIDs.pdb file, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
329 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
330 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
331 \& % ModifyPDBFiles.pl l \-m RenameChainIDs \-c B \-\-ChainIDRenameEmpty No
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
332 \& \-o Sample2.pdb
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
333 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
334 .SH "AUTHOR"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
335 .IX Header "AUTHOR"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
336 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
337 .SH "SEE ALSO"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
338 .IX Header "SEE ALSO"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
339 ExtractFromPDBFiles.pl, InfoPDBFiles.pl
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
340 .SH "COPYRIGHT"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
341 .IX Header "COPYRIGHT"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
342 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
343 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
344 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
345 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
346 MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
347 the terms of the \s-1GNU\s0 Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
348 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
349 any later version.