|
0
|
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
|
|
|
2 .\"
|
|
|
3 .\" Standard preamble:
|
|
|
4 .\" ========================================================================
|
|
|
5 .de Sp \" Vertical space (when we can't use .PP)
|
|
|
6 .if t .sp .5v
|
|
|
7 .if n .sp
|
|
|
8 ..
|
|
|
9 .de Vb \" Begin verbatim text
|
|
|
10 .ft CW
|
|
|
11 .nf
|
|
|
12 .ne \\$1
|
|
|
13 ..
|
|
|
14 .de Ve \" End verbatim text
|
|
|
15 .ft R
|
|
|
16 .fi
|
|
|
17 ..
|
|
|
18 .\" Set up some character translations and predefined strings. \*(-- will
|
|
|
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
|
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
|
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
|
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
|
23 .\" nothing in troff, for use with C<>.
|
|
|
24 .tr \(*W-
|
|
|
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
|
26 .ie n \{\
|
|
|
27 . ds -- \(*W-
|
|
|
28 . ds PI pi
|
|
|
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
|
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
|
31 . ds L" ""
|
|
|
32 . ds R" ""
|
|
|
33 . ds C` ""
|
|
|
34 . ds C' ""
|
|
|
35 'br\}
|
|
|
36 .el\{\
|
|
|
37 . ds -- \|\(em\|
|
|
|
38 . ds PI \(*p
|
|
|
39 . ds L" ``
|
|
|
40 . ds R" ''
|
|
|
41 'br\}
|
|
|
42 .\"
|
|
|
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
|
44 .ie \n(.g .ds Aq \(aq
|
|
|
45 .el .ds Aq '
|
|
|
46 .\"
|
|
|
47 .\" If the F register is turned on, we'll generate index entries on stderr for
|
|
|
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
|
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
|
50 .\" output yourself in some meaningful fashion.
|
|
|
51 .ie \nF \{\
|
|
|
52 . de IX
|
|
|
53 . tm Index:\\$1\t\\n%\t"\\$2"
|
|
|
54 ..
|
|
|
55 . nr % 0
|
|
|
56 . rr F
|
|
|
57 .\}
|
|
|
58 .el \{\
|
|
|
59 . de IX
|
|
|
60 ..
|
|
|
61 .\}
|
|
|
62 .\"
|
|
|
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
|
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
|
65 . \" fudge factors for nroff and troff
|
|
|
66 .if n \{\
|
|
|
67 . ds #H 0
|
|
|
68 . ds #V .8m
|
|
|
69 . ds #F .3m
|
|
|
70 . ds #[ \f1
|
|
|
71 . ds #] \fP
|
|
|
72 .\}
|
|
|
73 .if t \{\
|
|
|
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
|
75 . ds #V .6m
|
|
|
76 . ds #F 0
|
|
|
77 . ds #[ \&
|
|
|
78 . ds #] \&
|
|
|
79 .\}
|
|
|
80 . \" simple accents for nroff and troff
|
|
|
81 .if n \{\
|
|
|
82 . ds ' \&
|
|
|
83 . ds ` \&
|
|
|
84 . ds ^ \&
|
|
|
85 . ds , \&
|
|
|
86 . ds ~ ~
|
|
|
87 . ds /
|
|
|
88 .\}
|
|
|
89 .if t \{\
|
|
|
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
|
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
|
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
|
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
|
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
|
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
|
96 .\}
|
|
|
97 . \" troff and (daisy-wheel) nroff accents
|
|
|
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
|
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
|
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
|
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
|
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
|
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
|
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
|
105 .ds ae a\h'-(\w'a'u*4/10)'e
|
|
|
106 .ds Ae A\h'-(\w'A'u*4/10)'E
|
|
|
107 . \" corrections for vroff
|
|
|
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
|
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
|
110 . \" for low resolution devices (crt and lpr)
|
|
|
111 .if \n(.H>23 .if \n(.V>19 \
|
|
|
112 \{\
|
|
|
113 . ds : e
|
|
|
114 . ds 8 ss
|
|
|
115 . ds o a
|
|
|
116 . ds d- d\h'-1'\(ga
|
|
|
117 . ds D- D\h'-1'\(hy
|
|
|
118 . ds th \o'bp'
|
|
|
119 . ds Th \o'LP'
|
|
|
120 . ds ae ae
|
|
|
121 . ds Ae AE
|
|
|
122 .\}
|
|
|
123 .rm #[ #] #H #V #F C
|
|
|
124 .\" ========================================================================
|
|
|
125 .\"
|
|
|
126 .IX Title "INFOTEXTFILES 1"
|
|
|
127 .TH INFOTEXTFILES 1 "2015-03-29" "perl v5.14.2" "MayaChemTools"
|
|
|
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
|
129 .\" way too many mistakes in technical documents.
|
|
|
130 .if n .ad l
|
|
|
131 .nh
|
|
|
132 .SH "NAME"
|
|
|
133 InfoTextFiles.pl \- List information about TextFile(s)
|
|
|
134 .SH "SYNOPSIS"
|
|
|
135 .IX Header "SYNOPSIS"
|
|
|
136 InfoTextFiles.pl TextFile(s)...
|
|
|
137 .PP
|
|
|
138 InfoTextFiles.pl [\fB\-a, \-\-all\fR] [\fB\-c, \-\-count\fR] [\fB\-\-datacheck\fR] [\fB\-d, \-\-detail\fR infolevel] [\fB\-e, \-\-empty\fR]
|
|
|
139 [\fB\-h, \-\-help\fR] [\fB\-\-indelim\fR comma | semicolon] [\fB\-m, \-\-mode\fR colnum | collabel]
|
|
|
140 [\fB\-n, \-\-numericaldatacols\fR colnum,[colnum,...] | collabel,[collabel,...]]
|
|
|
141 [\fB\-w, \-\-workingdir\fR dirname] TextFile(s)...
|
|
|
142 .SH "DESCRIPTION"
|
|
|
143 .IX Header "DESCRIPTION"
|
|
|
144 List information about \fITextFile(s)\fR contents: number of lines and columns, empty
|
|
|
145 column values, and so on. The file names are separated by spaces.
|
|
|
146 The valid file extensions are \fI.csv\fR and \fI.tsv\fR for comma/semicolon and tab delimited
|
|
|
147 text files respectively. All other file names are ignored. All the text files in a
|
|
|
148 current directory can be specified by \fI*.csv\fR, \fI*.tsv\fR, or the current directory
|
|
|
149 name. The \fB\-\-indelim\fR option determines the format of \fITextFile(s)\fR. Any file
|
|
|
150 which doesn't correspond to the format indicated by \fB\-\-indelim\fR option is ignored.
|
|
|
151 .SH "OPTIONS"
|
|
|
152 .IX Header "OPTIONS"
|
|
|
153 .IP "\fB\-a, \-\-all\fR" 4
|
|
|
154 .IX Item "-a, --all"
|
|
|
155 List all the available information.
|
|
|
156 .IP "\fB\-c, \-\-count\fR" 4
|
|
|
157 .IX Item "-c, --count"
|
|
|
158 List number of rows and columns. This is \fBdefault behavior\fR.
|
|
|
159 .IP "\fB\-\-datacheck\fR" 4
|
|
|
160 .IX Item "--datacheck"
|
|
|
161 List number of numerical and non-numerical values for each column.
|
|
|
162 .IP "\fB\-d, \-\-detail\fR \fIinfolevel\fR" 4
|
|
|
163 .IX Item "-d, --detail infolevel"
|
|
|
164 Level of information to print about lines being ignored. Default: \fI1\fR. Possible values:
|
|
|
165 \&\fI1, 2 or 3\fR.
|
|
|
166 .IP "\fB\-e, \-\-empty\fR" 4
|
|
|
167 .IX Item "-e, --empty"
|
|
|
168 List number of empty row and column values.
|
|
|
169 .IP "\fB\-h, \-\-help\fR" 4
|
|
|
170 .IX Item "-h, --help"
|
|
|
171 Print this help message.
|
|
|
172 .IP "\fB\-\-indelim\fR \fIcomma | semicolon\fR" 4
|
|
|
173 .IX Item "--indelim comma | semicolon"
|
|
|
174 Input delimiter for \s-1CSV\s0 \fITextFile(s)\fR. Possible values: \fIcomma or semicolon\fR.
|
|
|
175 Default value: \fIcomma\fR. For \s-1TSV\s0 files, this option is ignored and \fItab\fR is used as a
|
|
|
176 delimiter.
|
|
|
177 .IP "\fB\-m, \-\-mode\fR \fIcolnum | collabel\fR" 4
|
|
|
178 .IX Item "-m, --mode colnum | collabel"
|
|
|
179 Specify how to identify numerical data columns: using column number or column label.
|
|
|
180 Possible values: \fIcolnum or collabel\fR. Default value: \fIcolnum\fR.
|
|
|
181 .IP "\fB\-n, \-\-numericaldatacols\fR \fIcolnum,[colnum,...] | collabel,[collabel,...]\fR" 4
|
|
|
182 .IX Item "-n, --numericaldatacols colnum,[colnum,...] | collabel,[collabel,...]"
|
|
|
183 This value is mode specific. It is a list of column number or labels to check for
|
|
|
184 presence of numerical data only; otherwise, the value is flagged. Default value: \fIall;all;...\fR.
|
|
|
185 .Sp
|
|
|
186 For \fIcolnum\fR mode, input value format is: \fIcolnum,...;colnum,...;...\fR. Example:
|
|
|
187 .Sp
|
|
|
188 .Vb 2
|
|
|
189 \& 1,3,5
|
|
|
190 \& "2,4,6"
|
|
|
191 .Ve
|
|
|
192 .Sp
|
|
|
193 For \fIcollabel\fR mode, input value format is: \fIcollabel,...;collabel,...;...\fR. Example:
|
|
|
194 .Sp
|
|
|
195 .Vb 1
|
|
|
196 \& "MW,SumNO,SumNHOH"
|
|
|
197 .Ve
|
|
|
198 .IP "\fB\-w, \-\-workingdir\fR \fIdirname\fR" 4
|
|
|
199 .IX Item "-w, --workingdir dirname"
|
|
|
200 Location of working directory. Default: current directory.
|
|
|
201 .SH "EXAMPLES"
|
|
|
202 .IX Header "EXAMPLES"
|
|
|
203 To count number of lines and columns in Text file(s), type:
|
|
|
204 .PP
|
|
|
205 .Vb 3
|
|
|
206 \& % InfoTextFiles.pl Sample1.csv
|
|
|
207 \& % InfoTextFiles.pl Sample1.csv Sample1.tsv
|
|
|
208 \& % InfoTextFiles.pl *.csv *.tsv
|
|
|
209 .Ve
|
|
|
210 .PP
|
|
|
211 To count number of lines, columns and empty values in Sample1.csv file and print
|
|
|
212 detailed information, type:
|
|
|
213 .PP
|
|
|
214 .Vb 1
|
|
|
215 \& % InfoTextFiles.pl \-d 3 \-e Sample1.csv
|
|
|
216 .Ve
|
|
|
217 .PP
|
|
|
218 To track all available information and non-numerical values for Mol_ID and MolWeight
|
|
|
219 columns in Sample1.csv file and print detailed information, type:
|
|
|
220 .PP
|
|
|
221 .Vb 1
|
|
|
222 \& % InfoTextFiles.pl \-d 3 \-a \-m collabel \-n Mol_ID,MolWeight Sample1.csv
|
|
|
223 .Ve
|
|
|
224 .SH "AUTHOR"
|
|
|
225 .IX Header "AUTHOR"
|
|
|
226 Manish Sud <msud@san.rr.com>
|
|
|
227 .SH "SEE ALSO"
|
|
|
228 .IX Header "SEE ALSO"
|
|
|
229 JoinTextFiles.pl, MergeTextFilesWithSD.pl, ModifyTextFilesFormat.pl, SplitTextFiles.pl, TextFilesToHTML.pl
|
|
|
230 .SH "COPYRIGHT"
|
|
|
231 .IX Header "COPYRIGHT"
|
|
|
232 Copyright (C) 2015 Manish Sud. All rights reserved.
|
|
|
233 .PP
|
|
|
234 This file is part of MayaChemTools.
|
|
|
235 .PP
|
|
|
236 MayaChemTools is free software; you can redistribute it and/or modify it under
|
|
|
237 the terms of the \s-1GNU\s0 Lesser General Public License as published by the Free
|
|
|
238 Software Foundation; either version 3 of the License, or (at your option)
|
|
|
239 any later version.
|
