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