annotate docs/scripts/txt/SortSDFiles.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 SortSDFiles.pl - Sort SDFile(s) using values for a data field
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 SortSDFiles.pl SDFile(s)...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 SortSDFiles.pl [-d, --detail infolevel] [-h, --help] [-k, --key *SD data
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8 field name*] [--keydata numeric | alphanumeric] [-o, --overwrite] [-r,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 --root rootname] [-s, --sort ascending | descending] [-w, --workingdir
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 dirname] SDFile(s)...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13 Sort *SDFile(s)* using values for a specified data field name key. Only
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 one SD data field name key can be specified for sorting. In an event of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 conflict during sorting process, two similar values for a SD data field
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 name key are simply transferred to output files in order of their
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 presence in input files. Additionally, compound records with no data
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 field name, empty field values, or field values containing multiple
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 lines are simply placed at the end. The file names are separated by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 space.The valid file extensions are *.sdf* and *.sd*. All other file
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 names are ignored. All the SD files in a current directory can be
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 specified either by **.sdf* or the current directory name.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 OPTIONS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25 -d, --detail *infolevel*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 Level of information to print about compound records being ignored.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 Default: *1*. Possible values: *1, 2 or 3*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 -h, --help
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 Print this help message.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 -k, --key *SD data field name*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 *SDFile(s)* data field name used for sorting compound records.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34 Default value: *first data field name*. Compound records with no
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 *sdfieldname*, empty field values, field values containing multiple
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36 lines, or field values inappropriate for sorting are simply placed
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 at the end.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 --keydata *numeric | alphanumeric*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 Data type for *sdfieldname* values. Possible values: *numeric or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41 alphanumeric*. Default value: *numeric*. For *alphanumeric* data
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 values, comparison is case insensitive.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44 -o, --overwrite
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45 Overwrite existing files.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 -r, --root *rootname*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48 New SD file name is generated using the root: <Root>.<Ext>. Default
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49 new file name: <InitialSDFileName>SortedByDataField.<Ext>. This
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 option is ignored for multiple input files.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52 -s, --sort *ascending | descending*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 Sorting order for SD data field values. Possible values: *ascending
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54 or descending*. Default value: *ascending*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56 -w, --workingdir *dirname*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57 Location of working directory. Default: current directory.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59 EXAMPLES
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60 To perform numerical sort in ascending order using first data field
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 values and generate a new SD file NewSample1.sdf, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63 % SortSDFiles.pl -o -r NewSample1 Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65 To perform numerical sort in descending order using MolWeight data field
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66 and generate a new SD text file NewSample1.sdf, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68 % SortSDFiles.pl -k MolWeight --keydata numeric -s descending
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69 -r NewSample1 -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75 JoinSDFiles.pl, MergeTextFilesWithSD.pl, SplitSDFiles.pl,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 SDFilesToHTML.pl
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83 MayaChemTools is free software; you can redistribute it and/or modify it
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84 under the terms of the GNU Lesser General Public License as published by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85 the Free Software Foundation; either version 3 of the License, or (at
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 your option) any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87