annotate docs/scripts/txt/SDToMolFiles.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 SDToMolFiles.pl - Generate MDLMOL file(s) from SD file(s)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 SDToMolFiles.pl SDFile(s)...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 SDToMolFiles.pl [-d, --DataField DataFieldName] [-m, --mode DataField |
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8 MolName | RootPrefix] [-h, --help] [-o, --overwrite] [-r, --root
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 rootname] [-w, --workingdir dirname] SDFile(s)...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 Generate MDLMOL file(s) from *SDFile(s)*. All header data labels and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13 values in SDFile(s) are simply ignored; other appopriate data from
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 SDFile(s) is transferred to MDLMOL files. Multiple *SDFile(s)* names are
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 separated by spaces. The valid file extensions are *.sdf* and *.sd*. All
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 other file names are ignored. All the SD files in a current directory
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 can be specified either by **.sdf* or the current directory name.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 OPTIONS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 -d, --DataField *DataFieldName*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 Specify *SDFile(s)* datafield label name whose value is used for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 generation of MDLMOL file names. Default value: *None*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 -h, --help
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25 Print this help message.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 -m, --mode *DataField | MolName | RootPrefix*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28 Specify how to generate MDLMOL file names: use a *SDFile(s)*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 datafield value; use molname line from *SDFile(s)*; generate a
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 sequential ID using root prefix specified by -r, --root option.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 Possible values: *DataField | MolName | RootPrefix | RootPrefix*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 Default: *RootPrefix*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 For empty *MolName* and *DataField* values during these specified
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36 modes, file name is automatically generated using *RootPrefix*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 For *RootPrefix* value of -m, --mode option, MDLMOL file names are
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 generated using by appending compound record number to value of -r,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 --root option. For example: *RootName*Cmd<RecordNumber>.mol.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 Allowed characters in file names are: a-zA-Z0-9_. All other
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 characters in datafield values, molname line, and root prefix are
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44 ignore during generation of file names.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46 -o, --overwrite
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 Overwrite existing files.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49 -r, --root *rootname*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 Specify root name to used during *RootPrefix* -m, --mode option
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 value. New MDLMOL file names are generated using the root:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52 <Root>Cmpd<RecordNumber>.mol Default for new file names:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 <InitialSDFileName>Cmpd<RecordNumber>.mol. This option is ignored
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54 for multiple input files.
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 generate MDLMOL files from Sample1*.sdf and Sample2*.sd files, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 % SDToMolFiles.pl -o Sample1*.sdf Sample2*.sd
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64 To generate Sample*.mol files from Sample1.sdf, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66 % SDToMolFiles.pl -r Sample -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68 To generate MOL files from Sample1.sdf using molname line data for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69 generating MOL file names, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71 % SDToMolFiles.pl -m MolName -r Sample -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73 To generate MOL files from Sample1.sdf using a specific data field
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 values for generating MOL file names, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 % SDToMolFiles.pl -m DataField --DataField MolID -r Sample
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77 -o Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84 InfoSDFiles.pl, MolFilesToSD.pl
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
90
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
91 MayaChemTools is free software; you can redistribute it and/or modify it
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
92 under the terms of the GNU Lesser General Public License as published by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
93 the Free Software Foundation; either version 3 of the License, or (at
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
94 your option) any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
95