annotate mayachemtools/docs/scripts/html/InfoSDFiles.html @ 0:73ae111cf86f draft

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 11:55:01 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 <html>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 <head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 <title>MayaChemTools:Documentation:InfoSDFiles.pl</title>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 <link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.css">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 </head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 <div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 <tr align="left" valign="top"><td width="33%" align="left"><a href="./InfoPeriodicTableElements.html" title="InfoPeriodicTableElements.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./InfoSequenceFiles.html" title="InfoSequenceFiles.html">Next</a></td><td width="34%" align="middle"><strong>InfoSDFiles.pl</strong></td><td width="33%" align="right"><a href="././code/InfoSDFiles.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/InfoSDFiles.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/InfoSDFiles.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/InfoSDFiles.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/InfoSDFiles.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 <h2>NAME</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 <p>InfoSDFiles.pl - List information about SDFile(s)</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 <h2>SYNOPSIS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 <p>InfoSDFile.pl SDFile(s)...</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 <p>InfoSDFile.pl [<strong>-a --all</strong>] [<strong>-c --count</strong>] [<strong>--chiral</strong>] [<strong>--datacheck</strong>]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 [<strong>-d --detail</strong> infolevel] [<strong>-e --empty</strong>] [<strong>-f, --fields</strong>] [<strong>-h, --help</strong>]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 [<strong>-i, --invalidatomnumbers</strong>] [<strong>-m, --mismatch</strong>] [<strong>-s, --salts</strong>] [<strong>-u, --unknownatoms</strong>]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 [<strong>-w, --workingdir</strong> dirname] SDFile(s)...</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 <h2>DESCRIPTION</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 <p>List information about <em>SDFile(s)</em> contents: number of compounds, empty records
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 and so on. Multiple SDFile names are separated by spaces. The valid file extensions
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 are <em>.sdf</em> and <em>.sd</em>. All other file names are ignored. All the SD files in a current
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 directory can be specified either by <em>*.sdf</em> or the current directory name.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 <h2>OPTIONS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 <dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 <dt><strong><strong>-a, --all</strong></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 <p>List all the available information.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 <dt><strong><strong>-c, --count</strong></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 <p>List number of compounds. This is <strong>default behavior</strong>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 <dt><strong><strong>--chiral</strong></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 <p>List number of empty atom/bond blocks for compounds with chiral flag set in
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 count line.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 <dt><strong><strong>-d, --detail</strong> <em>infolevel</em></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 <p>Level of information to print. Default: 1. Possible values: <em>1, 2, or 3</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 <dt><strong><strong>--datacheck</strong></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 <p>List number of numerical and non-numerical values for each data field.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 <dt><strong><strong>-e, --empty</strong></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 <p>List number of empty atom/bond blocks and data fields for compounds.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 <dt><strong><strong>-f, --fields</strong></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 <p>List data field labels present for compounds.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 <dt><strong><strong>-h, --help</strong></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 <p>Print this help message.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 <dt><strong><strong>-i, --invalidatomnumbers</strong></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 <p>List number of bond blocks for compounds which contain invalid atom numbers.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 <dt><strong><strong>-m, --mismatch</strong></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 <p>List number of atom/bond blocks for compounds which don't match with counts
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 line information in header block.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 <dt><strong><strong>-s, --salts</strong></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 <p>List number of atom blocks for compounds which contain salts identified as
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 disconnected structural units.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 <dt><strong><strong>-u, --unknownatoms</strong></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 <p>List number of atom blocks for compounds which contain special atom symbols
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 such as L, Q, * ,LP, X, R#, or any other non periodic table symbols.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 <dt><strong><strong>-w, --workingdir</strong> <em>dirname</em></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 <p>Location of working directory. Default: current directory.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 </dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 <h2>EXAMPLES</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 <p>To count compounds in SD file(s), type:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 <div class="ExampleBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 % InfoSDFiles.pl Sample1.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 <br/>% InfoSDFiles.pl Sample1.sdf Sample2.sdf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 <br/>% InfoSDFiles.pl *.sdf</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 <p>To list all available information for SD file(s), type:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 <div class="ExampleBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 % InfoSDFiles.pl -a *.sdf</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 <p>To list all data fields present in sample.sdf, type:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 <div class="ExampleBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 % InfoSDFiles.pl -f Sample.sdf</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 <p>To count number of compounds which contain salts and list associated structural
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 data, type:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 <div class="ExampleBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 % InfoSDFiles.pl -s -d 3 Sample.sdf</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 <h2>AUTHOR</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 <h2>SEE ALSO</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 <p><a href="./ExtractFromSDFiles.html">ExtractFromSDFiles.pl</a>,&nbsp<a href="./FilterSDFiles.html">FilterSDFiles.pl</a>,&nbsp<a href="./MergeTextFilesWithSD.html">MergeTextFilesWithSD.pl</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 <h2>COPYRIGHT</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129 <p>This file is part of MayaChemTools.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 any later version.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 <tr align="left" valign="top"><td width="33%" align="left"><a href="./InfoPeriodicTableElements.html" title="InfoPeriodicTableElements.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./InfoSequenceFiles.html" title="InfoSequenceFiles.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>InfoSDFiles.pl</strong></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 <br />
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 <img src="../../images/h2o2.png">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 </body>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 </html>