annotate mayachemtools/docs/scripts/html/SortSDFiles.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:SortSDFiles.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="./SimilaritySearchingFingerprints.html" title="SimilaritySearchingFingerprints.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./SortTextFiles.html" title="SortTextFiles.html">Next</a></td><td width="34%" align="middle"><strong>SortSDFiles.pl</strong></td><td width="33%" align="right"><a href="././code/SortSDFiles.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/SortSDFiles.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/SortSDFiles.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/SortSDFiles.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/SortSDFiles.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>SortSDFiles.pl - Sort SDFile(s) using values for a data field</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>SortSDFiles.pl SDFile(s)...</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 <p>SortSDFiles.pl [<strong>-d, --detail</strong> infolevel] [<strong>-h, --help</strong>] [<strong>-k, --key</strong> <em>SD data field name</em>]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 [<strong>--keydata</strong> numeric | alphanumeric] [<strong>-o, --overwrite</strong>] [<strong>-r, --root</strong> rootname]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 [<strong>-s, --sort</strong> ascending | descending] [<strong>-w, --workingdir</strong> dirname] SDFile(s)...</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 <h2>DESCRIPTION</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 <p>Sort <em>SDFile(s)</em> using values for a specified data field name key. Only one SD
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 data field name key can be specified for sorting. In an event of conflict during sorting
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 process, two similar values for a SD data field name key are simply transferred to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 output files in order of their presence in input files. Additionally, compound records
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 with no data field name, empty field values, or field values containing multiple lines
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 are simply placed at the end. The file names are separated by space.The valid file
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 extensions are <em>.sdf</em> and <em>.sd</em>. All other file names are ignored. All the SD files in a
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 current directory can be specified either by <em>*.sdf</em> or the current directory name.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 <h2>OPTIONS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 <dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 <dt><strong><strong>-d, --detail</strong> <em>infolevel</em></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 <p>Level of information to print about compound records being ignored. Default: <em>1</em>. Possible
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 values: <em>1, 2 or 3</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 <dt><strong><strong>-h, --help</strong></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 <p>Print this help message.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 <dt><strong><strong>-k, --key</strong> <em>SD data field name</em></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 <p><em>SDFile(s)</em> data field name used for sorting compound records. Default value: <em>first
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 data field name</em>. Compound records with no <em>sdfieldname</em>, empty field values, field
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 values containing multiple lines, or field values inappropriate for sorting are simply placed
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 at the end.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 <dt><strong><strong>--keydata</strong> <em>numeric | alphanumeric</em></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 <p>Data type for <em>sdfieldname</em> values. Possible values: <em>numeric or alphanumeric</em>. Default
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 value: <em>numeric</em>. For <em>alphanumeric</em> data values, comparison is case insensitive.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 <dt><strong><strong>-o, --overwrite</strong></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 <p>Overwrite existing files.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 <dt><strong><strong>-r, --root</strong> <em>rootname</em></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 <p>New SD file name is generated using the root: &lt;Root&gt;.&lt;Ext&gt;. Default new file
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 name: &lt;InitialSDFileName&gt;SortedByDataField.&lt;Ext&gt;. This option is ignored for multiple
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 input files.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 <dt><strong><strong>-s, --sort</strong> <em>ascending | descending</em></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 <p>Sorting order for SD data field values. Possible values: <em>ascending or descending</em>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 Default value: <em>ascending</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 <dt><strong><strong>-w, --workingdir</strong> <em>dirname</em></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 <p>Location of working directory. Default: current directory.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 </dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 <h2>EXAMPLES</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 <p>To perform numerical sort in ascending order using first data field values and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 generate a new SD file NewSample1.sdf, type:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 <div class="ExampleBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 % SortSDFiles.pl -o -r NewSample1 Sample1.sdf</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 <p>To perform numerical sort in descending order using MolWeight data field and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 generate a new SD text file NewSample1.sdf, type:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 <div class="ExampleBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 % SortSDFiles.pl -k MolWeight --keydata numeric -s descending
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 -r NewSample1 -o Sample1.sdf</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 <h2>AUTHOR</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 <h2>SEE ALSO</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 <p><a href="./JoinSDFiles.html">JoinSDFiles.pl</a>,&nbsp<a href="./MergeTextFilesWithSD.html">MergeTextFilesWithSD.pl</a>,&nbsp<a href="./SplitSDFiles.html">SplitSDFiles.pl</a>,&nbsp<a href="./SDFilesToHTML.html">SDFilesToHTML.pl</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 <h2>COPYRIGHT</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 <p>This file is part of MayaChemTools.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 any later version.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 <tr align="left" valign="top"><td width="33%" align="left"><a href="./SimilaritySearchingFingerprints.html" title="SimilaritySearchingFingerprints.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./SortTextFiles.html" title="SortTextFiles.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>SortSDFiles.pl</strong></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 <br />
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 <img src="../../images/h2o2.png">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 </body>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 </html>