annotate docs/scripts/txt/ModifyTextFilesFormat.txt @ 3:90ea638ce878 draft default tip

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