annotate docs/scripts/txt/ModifyTextFilesFormat.txt @ 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 NAME
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
2 ModifyTextFilesFormat.pl - Change CSV Textfile(s) into TSV Textfile(s)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3 and vice versa
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6 ModifyTextFilesFormat.pl TextFile(s)...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8 ModifyTextFilesFormat.pl [-h, --help] [--indelim comma | semicolon]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 [--outdelim comma | tab | semicolon] [-q, --quote yes | no] [-r, --root
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 rootname] [-w, --workingdir dirname] TextFile(s)...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13 Interchange CSV and TSV *TextFile(s)* format. Mutiple file names are
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 separated by spaces. The valid file extensions are *.csv* and *.tsv* for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 comma/semicolon and tab delimited text files respectively. All other
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 file names are ignored. All the text files in a current directory can be
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 specified by **.csv*, **.tsv*, or the current directory name. The
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 --indelim option determines the format of *TextFile(s)*. Any file which
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 doesn't correspond to the format indicated by --indelim option is
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 ignored.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 OPTIONS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 -h, --help
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 Print this help message.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 --indelim *comma | semicolon*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 Input delimiter for CSV *TextFile(s)*. Possible values: *comma or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28 semicolon*. Default value: *comma*. For TSV files, this option is
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 ignored and *tab* is used as a delimiter.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31 -o, --overwrite
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 Overwrite existing files.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34 --outdelim *comma | tab | semicolon*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 Output text file delimiter. Possible values: *comma, tab, or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36 semicolon* Default value: *comma*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 -q, --quote *yes | no*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 Put quotes around column values in output text file. Possible
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 values: *yes or no*. Default value: *yes*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 -r, --root *rootname*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 New text file name is generated using the root: <Root>.<Ext>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44 Default new file name: <InitialTextFileName>FormatModified.<Ext>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45 The csv, and tsv <Ext> values are used for comma/semicolon, and tab
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46 delimited text files respectively. This option is ignored for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 multiple input files.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49 -w, --workingdir *dirname*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 Location of working directory. Default: current directory.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52 EXAMPLES
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 To convert Sample*.csv into TSV files, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 % ModifyTextFilesFormat.pl --outdelim tab -q no -o Sample*.csv
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57 To convert Sample1.tsv into NewSample1.csv without any quotes around
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58 column data values, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60 % ModifyTextFilesFormat.pl --outdelim comma - q no
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 -r NewSample1 -o Sample1.tsv
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67 ModifyNewLineChar.pl
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 MayaChemTools is free software; you can redistribute it and/or modify it
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75 under the terms of the GNU Lesser General Public License as published by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 the Free Software Foundation; either version 3 of the License, or (at
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77 your option) any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78