Mercurial > repos > deepakjadmin > mayatool3_test1

comparison docs/scripts/html/InfoTextFiles.html @ 1:2abf0d43254d draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:10:43 -0500
parents
children
comparison
equal deleted inserted replaced
0:1791cb0984a7 1:2abf0d43254d
1 <html>
2 <head>
3 <title>MayaChemTools:Documentation:InfoTextFiles.pl</title>
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
5 <link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.css">
6 </head>
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
8 <br/>
9 <center>
10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
11 </center>
12 <br/>
13 <div class="DocNav">
14 <table width="100%" border=0 cellpadding=0 cellspacing=2>
15 <tr align="left" valign="top"><td width="33%" align="left"><a href="./InfoSequenceFiles.html" title="InfoSequenceFiles.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./JoinSDFiles.html" title="JoinSDFiles.html">Next</a></td><td width="34%" align="middle"><strong>InfoTextFiles.pl</strong></td><td width="33%" align="right"><a href="././code/InfoTextFiles.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/InfoTextFiles.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/InfoTextFiles.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/InfoTextFiles.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/InfoTextFiles.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr>
16 </table>
17 </div>
18 <p>
19 </p>
20 <h2>NAME</h2>
21 <p>InfoTextFiles.pl - List information about TextFile(s)</p>
22 <p>
23 </p>
24 <h2>SYNOPSIS</h2>
25 <p>InfoTextFiles.pl TextFile(s)...</p>
26 <p>InfoTextFiles.pl [<strong>-a, --all</strong>] [<strong>-c, --count</strong>] [<strong>--datacheck</strong>] [<strong>-d, --detail</strong> infolevel] [<strong>-e, --empty</strong>]
27 [<strong>-h, --help</strong>] [<strong>--indelim</strong> comma | semicolon] [<strong>-m, --mode</strong> colnum | collabel]
28 [<strong>-n, --numericaldatacols</strong> colnum,[colnum,...] | collabel,[collabel,...]]
29 [<strong>-w, --workingdir</strong> dirname] TextFile(s)...</p>
30 <p>
31 </p>
32 <h2>DESCRIPTION</h2>
33 <p>List information about <em>TextFile(s)</em> contents: number of lines and columns, empty
34 column values, and so on. The file names are separated by spaces.
35 The valid file extensions are <em>.csv</em> and <em>.tsv</em> for comma/semicolon and tab delimited
36 text files respectively. All other file names are ignored. All the text files in a
37 current directory can be specified by <em>*.csv</em>, <em>*.tsv</em>, or the current directory
38 name. The <strong>--indelim</strong> option determines the format of <em>TextFile(s)</em>. Any file
39 which doesn't correspond to the format indicated by <strong>--indelim</strong> option is ignored.</p>
40 <p>
41 </p>
42 <h2>OPTIONS</h2>
43 <dl>
44 <dt><strong><strong>-a, --all</strong></strong></dt>
45 <dd>
46 <p>List all the available information.</p>
47 </dd>
48 <dt><strong><strong>-c, --count</strong></strong></dt>
49 <dd>
50 <p>List number of rows and columns. This is <strong>default behavior</strong>.</p>
51 </dd>
52 <dt><strong><strong>--datacheck</strong></strong></dt>
53 <dd>
54 <p>List number of numerical and non-numerical values for each column.</p>
55 </dd>
56 <dt><strong><strong>-d, --detail</strong> <em>infolevel</em></strong></dt>
57 <dd>
58 <p>Level of information to print about lines being ignored. Default: <em>1</em>. Possible values:
59 <em>1, 2 or 3</em>.</p>
60 </dd>
61 <dt><strong><strong>-e, --empty</strong></strong></dt>
62 <dd>
63 <p>List number of empty row and column values.</p>
64 </dd>
65 <dt><strong><strong>-h, --help</strong></strong></dt>
66 <dd>
67 <p>Print this help message.</p>
68 </dd>
69 <dt><strong><strong>--indelim</strong> <em>comma | semicolon</em></strong></dt>
70 <dd>
71 <p>Input delimiter for CSV <em>TextFile(s)</em>. Possible values: <em>comma or semicolon</em>.
72 Default value: <em>comma</em>. For TSV files, this option is ignored and <em>tab</em> is used as a
73 delimiter.</p>
74 </dd>
75 <dt><strong><strong>-m, --mode</strong> <em>colnum | collabel</em></strong></dt>
76 <dd>
77 <p>Specify how to identify numerical data columns: using column number or column label.
78 Possible values: <em>colnum or collabel</em>. Default value: <em>colnum</em>.</p>
79 </dd>
80 <dt><strong><strong>-n, --numericaldatacols</strong> <em>colnum,[colnum,...] | collabel,[collabel,...]</em></strong></dt>
81 <dd>
82 <p>This value is mode specific. It is a list of column number or labels to check for
83 presence of numerical data only; otherwise, the value is flagged. Default value: <em>all;all;...</em>.</p>
84 <p>For <em>colnum</em> mode, input value format is: <em>colnum,...;colnum,...;...</em>. Example:</p>
85 <div class="OptionsBox">
86 1,3,5
87 <br/> &quot;2,4,6&quot;</div>
88 <p>For <em>collabel</em> mode, input value format is: <em>collabel,...;collabel,...;...</em>. Example:</p>
89 <div class="OptionsBox">
90 &quot;MW,SumNO,SumNHOH&quot;</div>
91 </dd>
92 <dt><strong><strong>-w, --workingdir</strong> <em>dirname</em></strong></dt>
93 <dd>
94 <p>Location of working directory. Default: current directory.</p>
95 </dd>
96 </dl>
97 <p>
98 </p>
99 <h2>EXAMPLES</h2>
100 <p>To count number of lines and columns in Text file(s), type:</p>
101 <div class="ExampleBox">
102 % InfoTextFiles.pl Sample1.csv
103 <br/>% InfoTextFiles.pl Sample1.csv Sample1.tsv
104 <br/>% InfoTextFiles.pl *.csv *.tsv</div>
105 <p>To count number of lines, columns and empty values in Sample1.csv file and print
106 detailed information, type:</p>
107 <div class="ExampleBox">
108 % InfoTextFiles.pl -d 3 -e Sample1.csv</div>
109 <p>To track all available information and non-numerical values for Mol_ID and MolWeight
110 columns in Sample1.csv file and print detailed information, type:</p>
111 <div class="ExampleBox">
112 % InfoTextFiles.pl -d 3 -a -m collabel -n Mol_ID,MolWeight Sample1.csv</div>
113 <p>
114 </p>
115 <h2>AUTHOR</h2>
116 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
117 <p>
118 </p>
119 <h2>SEE ALSO</h2>
120 <p><a href="./JoinTextFiles.html">JoinTextFiles.pl</a>,&nbsp<a href="./MergeTextFilesWithSD.html">MergeTextFilesWithSD.pl</a>,&nbsp<a href="./ModifyTextFilesFormat.html">ModifyTextFilesFormat.pl</a>,&nbsp<a href="./SplitTextFiles.html">SplitTextFiles.pl</a>,&nbsp<a href="./TextFilesToHTML.html">TextFilesToHTML.pl</a>
121 </p>
122 <p>
123 </p>
124 <h2>COPYRIGHT</h2>
125 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
126 <p>This file is part of MayaChemTools.</p>
127 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
128 the terms of the GNU Lesser General Public License as published by the Free
129 Software Foundation; either version 3 of the License, or (at your option)
130 any later version.</p>
131 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
132 <table width="100%" border=0 cellpadding=0 cellspacing=2>
133 <tr align="left" valign="top"><td width="33%" align="left"><a href="./InfoSequenceFiles.html" title="InfoSequenceFiles.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./JoinSDFiles.html" title="JoinSDFiles.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>InfoTextFiles.pl</strong></td></tr>
134 </table>
135 </div>
136 <br />
137 <center>
138 <img src="../../images/h2o2.png">
139 </center>
140 </body>
141 </html>