annotate docs/scripts/txt/MolFilesToSD.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 MolFilesToSD.pl - Generate a SD file from MDLMOL File(s)
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
3
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
5 MolFilesToSD.pl MDLMOLFile(s)...
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
6
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
7 MolFilesToSD.pl [-c, --compoundid usefileprefix | idlabel] [-d,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
8 --datafieldlabel fieldlabel] [-h, --help] [-m, --mode molnameline |
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
9 datafield | both | none] [-o, --overwrite] [-r, --root rootname] [-w,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
10 --workingdir dirname] MDLMOLFile(s)...
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
11
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
12 DESCRIPTION
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
13 Generate a SD file from *MDLMOL File(s)*. Multiple file names are
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
14 separated by spaces. The valid file extension is *.mol*. All other file
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
15 names are ignored. All the files in a current directory can be specified
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
16 by **.mol*, or the current directory name.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
17
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
18 OPTIONS
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
19 -c, --compoundid *usefileprefix | idlabel*
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
20 Specify how to generate compound IDs: use MOL filename prefix or
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
21 generate a new compound ID by combining *idlabel* with compound
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
22 number. Possible values: *usefileprefix | idlabel*. By default,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
23 *Cmd* is used as a *idlabel* to generate these types of compound
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
24 IDs: Cmpd1, Cmpd2 and so on.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
25
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
26 Example: To generate compound IDs like Mol_ID1, Mol_ID2 and so on,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
27 specify "MolID" value for this option.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
28
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
29 -d, --datafieldlabel *fieldlabel*
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
30 Specify data field label for adding compound ID field into SD file
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
31 during *datafield | both* values of -m, --mode option. Default:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
32 <Cmpd_ID>.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
33
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
34 -h, --help
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
35 Print this help message.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
36
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
37 -m, --mode *molnameline | datafield | both | none*
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
38 Specify how to add compopund ID into SD file: relplace the molname
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
39 line, add a new data field, replace the molname line and add data
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
40 field, or do nothing. Possible values: *molnameline | datafield |
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
41 both | none*. Default: *nothing*.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
42
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
43 Use -c, --compoundid to specify compound ID generation process.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
44
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
45 -o, --overwrite
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
46 Overwrite existing files.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
47
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
48 -r, --root *rootname*
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
49 New SD file name is generated using the root: <Root>.sdf. Default
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
50 new file name: <InitialMOLFileName>1To<Count>.sdf.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
51
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
52 -w, --workingdir *dirname*
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
53 Location of working directory. Default: current directory.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
54
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
55 EXAMPLES
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
56 To generate NewSample.sdf file from Sample*.mol files, type:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
57
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
58 % MolFilesToSD.pl -r NewSample -o Sample*.mol
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
59
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
60 To generate NewSample.sdf with Cmpd1, Cmpd2 and so on as compound ID in
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
61 MolName line and Cmpd_ID datafield from Sample*.mol files, type:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
62
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
63 % MolFilesToSD.pl -r NewSample -m both -o Sample*.mol
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
64
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
65 AUTHOR
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
66 Manish Sud <msud@san.rr.com>
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
67
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
68 SEE ALSO
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
69 InfoSDFiles.pl, SDToMolFiles.pl
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
70
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
71 COPYRIGHT
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
72 Copyright (C) 2015 Manish Sud. All rights reserved.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
73
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
74 This file is part of MayaChemTools.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
75
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
76 MayaChemTools is free software; you can redistribute it and/or modify it
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
77 under the terms of the GNU Lesser General Public License as published by
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
78 the Free Software Foundation; either version 3 of the License, or (at
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
79 your option) any later version.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
80