annotate mayachemtools/docs/scripts/txt/InfoTextFiles.txt @ 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 NAME
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 InfoTextFiles.pl - List information about TextFile(s)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 InfoTextFiles.pl TextFile(s)...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 InfoTextFiles.pl [-a, --all] [-c, --count] [--datacheck] [-d, --detail
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 infolevel] [-e, --empty] [-h, --help] [--indelim comma | semicolon] [-m,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 --mode colnum | collabel] [-n, --numericaldatacols colnum,[colnum,...] |
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 collabel,[collabel,...]] [-w, --workingdir dirname] TextFile(s)...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 DESCRIPTION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 List information about *TextFile(s)* contents: number of lines and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 columns, empty column values, and so on. The file names are separated by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 spaces. The valid file extensions are *.csv* and *.tsv* for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 comma/semicolon and tab delimited text files respectively. All other
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 file names are ignored. All the text files in a current directory can be
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 specified by **.csv*, **.tsv*, or the current directory name. The
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 --indelim option determines the format of *TextFile(s)*. Any file which
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 doesn't correspond to the format indicated by --indelim option is
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 ignored.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 OPTIONS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 -a, --all
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 List all the available information.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 -c, --count
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 List number of rows and columns. This is default behavior.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 --datacheck
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 List number of numerical and non-numerical values for each column.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 -d, --detail *infolevel*
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 Level of information to print about lines being ignored. Default:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 *1*. Possible values: *1, 2 or 3*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 -e, --empty
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 List number of empty row and column values.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 -h, --help
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 Print this help message.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 --indelim *comma | semicolon*
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 Input delimiter for CSV *TextFile(s)*. Possible values: *comma or
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 semicolon*. Default value: *comma*. For TSV files, this option is
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 ignored and *tab* is used as a delimiter.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 -m, --mode *colnum | collabel*
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 Specify how to identify numerical data columns: using column number
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 or column label. Possible values: *colnum or collabel*. Default
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 value: *colnum*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 -n, --numericaldatacols *colnum,[colnum,...] | collabel,[collabel,...]*
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 This value is mode specific. It is a list of column number or labels
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 to check for presence of numerical data only; otherwise, the value
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 is flagged. Default value: *all;all;...*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 For *colnum* mode, input value format is:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 *colnum,...;colnum,...;...*. Example:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 1,3,5
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 "2,4,6"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 For *collabel* mode, input value format is:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 *collabel,...;collabel,...;...*. Example:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 "MW,SumNO,SumNHOH"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 -w, --workingdir *dirname*
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 Location of working directory. Default: current directory.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 EXAMPLES
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 To count number of lines and columns in Text file(s), type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 % InfoTextFiles.pl Sample1.csv
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 % InfoTextFiles.pl Sample1.csv Sample1.tsv
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 % InfoTextFiles.pl *.csv *.tsv
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 To count number of lines, columns and empty values in Sample1.csv file
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 and print detailed information, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 % InfoTextFiles.pl -d 3 -e Sample1.csv
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 To track all available information and non-numerical values for Mol_ID
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 and MolWeight columns in Sample1.csv file and print detailed
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 information, type:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 % InfoTextFiles.pl -d 3 -a -m collabel -n Mol_ID,MolWeight Sample1.csv
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 AUTHOR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 SEE ALSO
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 JoinTextFiles.pl, MergeTextFilesWithSD.pl, ModifyTextFilesFormat.pl,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 SplitTextFiles.pl, TextFilesToHTML.pl
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 COPYRIGHT
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 MayaChemTools is free software; you can redistribute it and/or modify it
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 under the terms of the GNU Lesser General Public License as published by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 the Free Software Foundation; either version 3 of the License, or (at
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 your option) any later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106