annotate docs/scripts/html/SplitTextFiles.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:SplitTextFiles.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="./SplitSDFiles.html" title="SplitSDFiles.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./TextFilesToHTML.html" title="TextFilesToHTML.html">Next</a></td><td width="34%" align="middle"><strong>SplitTextFiles.pl</strong></td><td width="33%" align="right"><a href="././code/SplitTextFiles.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/SplitTextFiles.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/SplitTextFiles.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/SplitTextFiles.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/SplitTextFiles.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>SplitTextFiles.pl - Split CSV or TSV TextFile(s) into multiple text files</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>SplitTextFiles.pl TextFile(s)...</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 <p>SplitTextFiles.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>-n, --numfiles</strong> number] [<strong>-o, --overwrite</strong>]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28 [<strong>--outdelim</strong> comma | tab | semicolon] [<strong>-q, --quote</strong> yes | no]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 [<strong>-r, --root</strong> rootname] [<strong>-w, --workingdir</strong> dirname] TextFile(s)...</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 <h2>DESCRIPTION</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 <p>Split CSV or TSV <em>TextFile(s)</em> into multiple text files. Each new text file contains
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34 a subset of similar number of lines from the initial file. The file names are separated
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 by space. The valid file extensions are <em>.csv</em> and <em>.tsv</em> for comma/semicolon and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36 tab delimited text files respectively. All other file names are ignored. All the text
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 files in a current directory can be specified by <em>*.csv</em>, <em>*.tsv</em>, or the current
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 directory name. The <strong>--indelim</strong> option determines the format of <em>TextFile(s)</em>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 Any file which doesn't correspond to the format indicated by <strong>--indelim</strong> option
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 is ignored.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 <h2>OPTIONS</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44 <dl>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45 <dt><strong><strong>-f, --fast</strong></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 <p>In this mode, <strong>--indelim, --outdelim</strong>, and <strong>-q --quote</strong> options are ignored. The
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48 format of input and output file(s) are assumed to be similar. And the text lines
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49 from input <em>TextFile(s)</em> are just transferred to output file(s) without any processing.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 <dt><strong><strong>-h, --help</strong></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 <p>Print this help message.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 <dt><strong><strong>--indelim</strong> <em>comma | semicolon</em></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57 <p>Input delimiter for CSV <em>TextFile(s)</em>. Possible values: <em>comma or semicolon</em>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58 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
59 delimiter.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 <dt><strong><strong>-l, --label</strong> <em>yes | no</em></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63 <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
64 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65 <dt><strong><strong>-n, --numfiles</strong> <em>number</em></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67 <p>Number of new files to generate for each TextFile(s). Default: <em>2</em>.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69 <dt><strong><strong>-o, --overwrite</strong></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71 <p>Overwrite existing files.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73 <dt><strong><strong>--outdelim</strong> <em>comma | tab | semicolon</em></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75 <p>Output text file delimiter. Possible values: <em>comma, tab, or semicolon</em>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 Default value: <em>comma</em></p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78 <dt><strong><strong>-q, --quote</strong> <em>yes | no</em></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80 <p>Put quotes around column values in output text file. Possible values: <em>yes or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 no</em>. Default value: <em>yes</em>.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83 <dt><strong><strong>-r, --root</strong> <em>rootname</em></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85 <p>New text file names are generated using the root: &lt;Root&gt;Part&lt;Count&gt;.&lt;Ext&gt;.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 Default new file names: &lt;InitialTextFileName&gt;Part&lt;Count&gt;.&lt;Ext&gt;. The csv, and tsv
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87 &lt;Ext&gt; values are used for comma/semicolon, and tab delimited text files
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88 respectively.This option is ignored for multiple input files.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
90 <dt><strong><strong>-w, --workingdir</strong> <em>dirname</em></strong></dt>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
91 <dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
92 <p>Location of working directory. Default: current directory.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
93 </dd>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
94 </dl>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
95 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
96 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
97 <h2>EXAMPLES</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
98 <p>To split each CSV text files into 4 different text files type:</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
99 <div class="ExampleBox">
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
100 % SplitTextFiles.pl -n 5 -o Sample1.csv Sample2.csv
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
101 <br/>% SplitTextFiles.pl -n 5 -o *.csv</div>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
102 <p>To split Sample1.tsv into 10 different CSV text files, type:</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
103 <div class="ExampleBox">
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
104 % SplitTextFiles.pl -n 10 --outdelim comma -o Sample1.tsv</div>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
105 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
106 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
107 <h2>AUTHOR</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
108 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
109 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
110 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
111 <h2>SEE ALSO</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
112 <p><a href="./JoinTextFiles.html">JoinTextFiles.pl</a>,&nbsp<a href="./MergeTextFiles.html">MergeTextFiles.pl</a>,&nbsp<a href="./ModifyTextFilesFormat.html">ModifyTextFilesFormat.pl</a>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
113 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
114 <p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
115 </p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
116 <h2>COPYRIGHT</h2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
117 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
118 <p>This file is part of MayaChemTools.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
119 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
120 the terms of the GNU Lesser General Public License as published by the Free
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
121 Software Foundation; either version 3 of the License, or (at your option)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
122 any later version.</p>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
123 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
124 <table width="100%" border=0 cellpadding=0 cellspacing=2>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
125 <tr align="left" valign="top"><td width="33%" align="left"><a href="./SplitSDFiles.html" title="SplitSDFiles.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./TextFilesToHTML.html" title="TextFilesToHTML.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>SplitTextFiles.pl</strong></td></tr>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
126 </table>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
127 </div>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
128 <br />
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
129 <center>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
130 <img src="../../images/h2o2.png">
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
131 </center>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
132 </body>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
133 </html>