diff mayachemtools/docs/scripts/man1/InfoTextFiles.1 @ 0:73ae111cf86f draft

Uploaded

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mayachemtools/docs/scripts/man1/InfoTextFiles.1	Wed Jan 20 11:55:01 2016 -0500
@@ -0,0 +1,239 @@
+.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.ie \nF \{\
+.    de IX
+.    tm Index:\\$1\t\\n%\t"\\$2"
+..
+.    nr % 0
+.    rr F
+.\}
+.el \{\
+.    de IX
+..
+.\}
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "INFOTEXTFILES 1"
+.TH INFOTEXTFILES 1 "2015-03-29" "perl v5.14.2" "MayaChemTools"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+InfoTextFiles.pl \- List information about TextFile(s)
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+InfoTextFiles.pl TextFile(s)...
+.PP
+InfoTextFiles.pl [\fB\-a, \-\-all\fR] [\fB\-c, \-\-count\fR] [\fB\-\-datacheck\fR] [\fB\-d, \-\-detail\fR infolevel] [\fB\-e, \-\-empty\fR]
+[\fB\-h, \-\-help\fR] [\fB\-\-indelim\fR comma | semicolon] [\fB\-m, \-\-mode\fR colnum | collabel]
+[\fB\-n, \-\-numericaldatacols\fR colnum,[colnum,...] | collabel,[collabel,...]]
+[\fB\-w, \-\-workingdir\fR dirname] TextFile(s)...
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+List information about \fITextFile(s)\fR contents: number of lines and columns, empty
+column values, and so on. The file names are separated by spaces.
+The valid file extensions are \fI.csv\fR and \fI.tsv\fR for comma/semicolon and tab delimited
+text files respectively. All other file names are ignored. All the text files in a
+current directory can be specified by \fI*.csv\fR, \fI*.tsv\fR, or the current directory
+name. The \fB\-\-indelim\fR option determines the format of \fITextFile(s)\fR. Any file
+which doesn't correspond to the format indicated by \fB\-\-indelim\fR option is ignored.
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.IP "\fB\-a, \-\-all\fR" 4
+.IX Item "-a, --all"
+List all the available information.
+.IP "\fB\-c, \-\-count\fR" 4
+.IX Item "-c, --count"
+List number of rows and columns. This is \fBdefault behavior\fR.
+.IP "\fB\-\-datacheck\fR" 4
+.IX Item "--datacheck"
+List number of numerical and non-numerical values for each column.
+.IP "\fB\-d, \-\-detail\fR \fIinfolevel\fR" 4
+.IX Item "-d, --detail infolevel"
+Level of information to print about lines being ignored. Default: \fI1\fR. Possible values:
+\&\fI1, 2 or 3\fR.
+.IP "\fB\-e, \-\-empty\fR" 4
+.IX Item "-e, --empty"
+List number of empty row and column values.
+.IP "\fB\-h, \-\-help\fR" 4
+.IX Item "-h, --help"
+Print this help message.
+.IP "\fB\-\-indelim\fR \fIcomma | semicolon\fR" 4
+.IX Item "--indelim comma | semicolon"
+Input delimiter for \s-1CSV\s0 \fITextFile(s)\fR. Possible values: \fIcomma or semicolon\fR.
+Default value: \fIcomma\fR. For \s-1TSV\s0 files, this option is ignored and \fItab\fR is used as a
+delimiter.
+.IP "\fB\-m, \-\-mode\fR \fIcolnum | collabel\fR" 4
+.IX Item "-m, --mode colnum | collabel"
+Specify how to identify numerical data columns: using column number or column label.
+Possible values: \fIcolnum or collabel\fR. Default value: \fIcolnum\fR.
+.IP "\fB\-n, \-\-numericaldatacols\fR \fIcolnum,[colnum,...] | collabel,[collabel,...]\fR" 4
+.IX Item "-n, --numericaldatacols colnum,[colnum,...] | collabel,[collabel,...]"
+This value is mode specific. It is a list of column number or labels to check for
+presence of numerical data only; otherwise, the value is flagged. Default value: \fIall;all;...\fR.
+.Sp
+For \fIcolnum\fR mode, input value format is: \fIcolnum,...;colnum,...;...\fR. Example:
+.Sp
+.Vb 2
+\&    1,3,5
+\&    "2,4,6"
+.Ve
+.Sp
+For \fIcollabel\fR mode, input value format is: \fIcollabel,...;collabel,...;...\fR. Example:
+.Sp
+.Vb 1
+\&    "MW,SumNO,SumNHOH"
+.Ve
+.IP "\fB\-w, \-\-workingdir\fR \fIdirname\fR" 4
+.IX Item "-w, --workingdir dirname"
+Location of working directory. Default: current directory.
+.SH "EXAMPLES"
+.IX Header "EXAMPLES"
+To count number of lines and columns in Text file(s), type:
+.PP
+.Vb 3
+\&    % InfoTextFiles.pl Sample1.csv
+\&    % InfoTextFiles.pl Sample1.csv Sample1.tsv
+\&    % InfoTextFiles.pl *.csv *.tsv
+.Ve
+.PP
+To count number of lines, columns and empty values in Sample1.csv file and print
+detailed information, type:
+.PP
+.Vb 1
+\&    % InfoTextFiles.pl \-d 3 \-e Sample1.csv
+.Ve
+.PP
+To track all available information and non-numerical values for Mol_ID and MolWeight
+columns in Sample1.csv file and print detailed information, type:
+.PP
+.Vb 1
+\&    % InfoTextFiles.pl \-d 3 \-a \-m collabel \-n Mol_ID,MolWeight Sample1.csv
+.Ve
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Manish Sud <[e-mail]>
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+JoinTextFiles.pl, MergeTextFilesWithSD.pl, ModifyTextFilesFormat.pl, SplitTextFiles.pl, TextFilesToHTML.pl
+.SH "COPYRIGHT"
+.IX Header "COPYRIGHT"
+Copyright (C) 2015 Manish Sud. All rights reserved.
+.PP
+This file is part of MayaChemTools.
+.PP
+MayaChemTools is free software; you can redistribute it and/or modify it under
+the terms of the \s-1GNU\s0 Lesser General Public License as published by the Free
+Software Foundation; either version 3 of the License, or (at your option)
+any later version.