annotate mayachemtool/mayachemtools/docs/scripts/txt/JoinTextFiles.txt @ 0:68300206e90d draft default tip

Uploaded
author deepakjadmin
date Thu, 05 Nov 2015 02:41:30 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
2 JoinTextFiles.pl - Join multiple CSV or TSV text files into a single
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
3 text file
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
4
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
5 SYNOPSIS
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
6 JoinTextFiles.pl TextFiles...
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
7
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
8 JoinTextFiles.pl [-f, --fast] [-h, --help] [--indelim comma | semicolon]
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
9 [-l, --label yes | no] [-o, --overwrite] [--outdelim comma | tab |
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
10 semicolon] [-q, --quote yes | no] [-r, --root rootname] [-w,
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
11 --workingdir dirname] TextFiles...
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
12
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
13 DESCRIPTION
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
14 Multiple CSV or TSV *TextFiles* are joined to generate a single text
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
15 file. The file names are separated by spaces. The valid file extensions
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
16 are *.csv* and *.tsv* for comma/semicolon and tab delimited text files
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
17 respectively. All other file names are ignored. All the text files in a
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
18 current directory can be specified by **.csv*, **.tsv*, or the current
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
19 directory name. The --indelim option determines the format of
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
20 *TextFiles*. Any file which doesn't correspond to the format indicated
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
21 by --indelim option is ignored.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
22
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
23 OPTIONS
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
24 -f, --fast
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
25 In this mode, --indelim and -q --quote options are ignored. The
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
26 format of input and output file(s) are assumed to be similar. And
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
27 the text lines from *TextFiles* are simply transferred to output
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
28 file without any processing.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
29
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
30 -h, --help
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
31 Print this help message.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
32
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
33 --indelim *comma | semicolon*
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
34 Input delimiter for CSV *TextFile(s)*. Possible values: *comma or
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
35 semicolon*. Default value: *comma*. For TSV files, this option is
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
36 ignored and *tab* is used as a delimiter.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
37
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
38 -l, --label *yes | no*
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
39 First line contains column labels. Possible values: *yes or no*.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
40 Default value: *yes*.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
41
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
42 -o, --overwrite
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
43 Overwrite existing files.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
44
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
45 --outdelim *comma | tab | semicolon*
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
46 Output text file delimiter. Possible values: *comma, tab, or
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
47 semicolon* Default value: *comma*.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
48
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
49 -q, --quote *yes | no*
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
50 Put quotes around column values in output text file. Possible
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
51 values: *yes or no*. Default value: *yes*.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
52
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
53 -r, --root *rootname*
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
54 New text file name is generated using the root: <Root>.<Ext>.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
55 Default file name: <FirstTextFileName>1To<Count>Joined.<Ext>. The
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
56 csv, and tsv <Ext> values are used for comma/semicolon, and tab
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
57 delimited text files respectively.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
58
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
59 -w, --workingdir *dirname*
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
60 Location of working directory. Default: current directory.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
61
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
62 EXAMPLES
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
63 To join CSV text files, type:
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
64
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
65 % JoinTextFiles.pl -o Sample1.csv Sample2.csv
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
66 % JoinTextFiles.pl -o *.csv
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
67
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
68 To join Sample*.tsv TSV text files into a NewSample.tsv file, type:
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
69
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
70 % JoinTextFiles.pl -o -r NewSample Sample*.tsv
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
71
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
72 AUTHOR
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
73 Manish Sud <msud@san.rr.com>
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
74
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
75 SEE ALSO
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
76 MergeTextFiles.pl, ModifyTextFilesFormat.pl, SplitTextFiles.pl
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
77
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
78 COPYRIGHT
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
79 Copyright (C) 2015 Manish Sud. All rights reserved.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
80
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
81 This file is part of MayaChemTools.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
82
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
83 MayaChemTools is free software; you can redistribute it and/or modify it
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
84 under the terms of the GNU Lesser General Public License as published by
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
85 the Free Software Foundation; either version 3 of the License, or (at
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
86 your option) any later version.
68300206e90d Uploaded
deepakjadmin
parents:
diff changeset
87