annotate docs/scripts/html/JoinTextFiles.html @ 0:4816e4a8ae95 draft default tip

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:23:18 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
1 <html>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
2 <head>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3 <title>MayaChemTools:Documentation:JoinTextFiles.pl</title>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 <link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.css">
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6 </head>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8 <br/>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 <center>
4816e4a8ae95 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>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11 </center>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 <br/>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13 <div class="DocNav">
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 <table width="100%" border=0 cellpadding=0 cellspacing=2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 <tr align="left" valign="top"><td width="33%" align="left"><a href="./JoinSDFiles.html" title="JoinSDFiles.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./MACCSKeysFingerprints.html" title="MACCSKeysFingerprints.html">Next</a></td><td width="34%" align="middle"><strong>JoinTextFiles.pl</strong></td><td width="33%" align="right"><a href="././code/JoinTextFiles.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/JoinTextFiles.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/JoinTextFiles.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/JoinTextFiles.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/JoinTextFiles.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 </table>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 </div>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 <h2>NAME</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 <p>JoinTextFiles.pl - Join multiple CSV or TSV text files into a single text file</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 <h2>SYNOPSIS</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25 <p>JoinTextFiles.pl TextFiles...</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 <p>JoinTextFiles.pl [<strong>-f, --fast</strong>] [<strong>-h, --help</strong>] [<strong>--indelim</strong> comma | semicolon]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 [<strong>-l, --label</strong> yes | no] [<strong>-o, --overwrite</strong>] [<strong>--outdelim</strong> comma | tab | semicolon]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28 [<strong>-q, --quote</strong> yes | no] [<strong>-r, --root</strong> rootname] [<strong>-w, --workingdir</strong> dirname] TextFiles...</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31 <h2>DESCRIPTION</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 <p>Multiple CSV or TSV <em>TextFiles</em> are joined to generate a single text file. The
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 file names are separated by spaces. The valid file extensions are <em>.csv</em> and <em>.tsv</em>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34 for comma/semicolon and tab delimited text files respectively. All other file names
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 are ignored. All the text files in a current directory can be specified by <em>*.csv</em>,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36 <em>*.tsv</em>, or the current directory name. The <strong>--indelim</strong> option determines the
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 format of <em>TextFiles</em>. Any file which doesn't correspond to the format indicated
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 by <strong>--indelim</strong> option is ignored.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41 <h2>OPTIONS</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 <dl>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 <dt><strong><strong>-f, --fast</strong></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45 <p>In this mode, <strong>--indelim</strong> and <strong>-q --quote</strong> options are ignored. The format of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46 input and output file(s) are assumed to be similar. And the text lines from <em>TextFiles</em>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 are simply transferred to output file without any processing.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49 <dt><strong><strong>-h, --help</strong></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 <p>Print this help message.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 <dt><strong><strong>--indelim</strong> <em>comma | semicolon</em></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 <p>Input delimiter for CSV <em>TextFile(s)</em>. Possible values: <em>comma or semicolon</em>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56 Default value: <em>comma</em>. For TSV files, this option is ignored and <em>tab</em> is used as a
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57 delimiter.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59 <dt><strong><strong>-l, --label</strong> <em>yes | no</em></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 <p>First line contains column labels. Possible values: <em>yes or no</em>. Default value: <em>yes</em>.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63 <dt><strong><strong>-o, --overwrite</strong></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65 <p>Overwrite existing files.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67 <dt><strong><strong>--outdelim</strong> <em>comma | tab | semicolon</em></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69 <p>Output text file delimiter. Possible values: <em>comma, tab, or semicolon</em>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70 Default value: <em>comma</em>.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 <dt><strong><strong>-q, --quote</strong> <em>yes | no</em></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 <p>Put quotes around column values in output text file. Possible values: <em>yes or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75 no</em>. Default value: <em>yes</em>.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77 <dt><strong><strong>-r, --root</strong> <em>rootname</em></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79 <p>New text file name is generated using the root: &lt;Root&gt;.&lt;Ext&gt;. Default file
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80 name: &lt;FirstTextFileName&gt;1To&lt;Count&gt;Joined.&lt;Ext&gt;. The csv, and tsv
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 &lt;Ext&gt; values are used for comma/semicolon, and tab delimited text files
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82 respectively.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84 <dt><strong><strong>-w, --workingdir</strong> <em>dirname</em></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 <p>Location of working directory. Default: current directory.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88 </dl>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
90 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
91 <h2>EXAMPLES</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
92 <p>To join CSV text files, type:</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
93 <div class="ExampleBox">
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
94 % JoinTextFiles.pl -o Sample1.csv Sample2.csv
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
95 <br/>% JoinTextFiles.pl -o *.csv</div>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
96 <p>To join Sample*.tsv TSV text files into a NewSample.tsv file, type:</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
97 <div class="ExampleBox">
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
98 % JoinTextFiles.pl -o -r NewSample Sample*.tsv</div>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
99 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
100 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
101 <h2>AUTHOR</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
102 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
103 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
104 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
105 <h2>SEE ALSO</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
106 <p><a href="./MergeTextFiles.html">MergeTextFiles.pl</a>,&nbsp<a href="./ModifyTextFilesFormat.html">ModifyTextFilesFormat.pl</a>,&nbsp<a href="./SplitTextFiles.html">SplitTextFiles.pl</a>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
107 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
108 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
109 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
110 <h2>COPYRIGHT</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
111 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
112 <p>This file is part of MayaChemTools.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
113 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
114 the terms of the GNU Lesser General Public License as published by the Free
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
115 Software Foundation; either version 3 of the License, or (at your option)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
116 any later version.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
117 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
118 <table width="100%" border=0 cellpadding=0 cellspacing=2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
119 <tr align="left" valign="top"><td width="33%" align="left"><a href="./JoinSDFiles.html" title="JoinSDFiles.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./MACCSKeysFingerprints.html" title="MACCSKeysFingerprints.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>JoinTextFiles.pl</strong></td></tr>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
120 </table>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
121 </div>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
122 <br />
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
123 <center>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
124 <img src="../../images/h2o2.png">
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
125 </center>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
126 </body>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
127 </html>