annotate docs/scripts/txt/ElementalAnalysisSDFiles.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 ElementalAnalysisSDFiles.pl - Perform elemental analysis using formula
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3 data field in SDFile(s)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6 ElementalAnalysisSDFiles.pl SDFile(s)...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8 ElementalAnalysisSDFiles.pl [-d, --detail infolevel] [--fast]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 [--formulafield SD data field name] [-f, --formulamode *DataField |
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 StructureData*] [--formulaout yes or no] [-m, --mode All |
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11 "ElementalAnalysis, [MolecularWeight, ExactMass]"] [-h, --help] [-o,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 --overwrite] [-r, --root rootname] [-v --valuefieldnames Name, Label,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13 [Name, Label,...]] [-w, --workingdir dirname] SDFile(s)...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 Perform elemental analysis using molecular formula specified by a data
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 field name or generated from structure data in *SDFile(s)*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 In addition to straightforward molecular formulas - H2O, HCl, C3H7O2N -
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 other supported variations are: Ca3(PO4)2, [PCl4]+, [Fe(CN)6]4-,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 C37H42N2O6+2, Na2CO3.10H2O, 8H2S.46H2O, and so on. Charges are simply
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 ignored. Isotope symbols in formulas specification, including D and T,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 are not supported.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25 The file names are separated by space.The valid file extensions are
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 *.sdf* and *.sd*. All other file names are ignored. All the SD files in
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 a current directory can be specified either by **.sdf* or the current
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28 directory name.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 OPTIONS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31 -d, --detail *infolevel*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 Level of information to print about compound records being ignored.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 Default: *1*. Possible values: *1, 2 or 3*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 --fast
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36 In this mode, the formula data field specified using -f,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 --formulafield option is assumed to contain valid molecular formula
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 data and initial formula validation check is skipped.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 --formulafield *SD data field name*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41 *SDFile(s)* data field name containing molecular formulas used for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 performing elemental analysis during *DataField* value of -f,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 --formulamode option. Default value: *SD data field containing the
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44 word formula in its name*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46 This option is ignore during *StructureData* value of -f,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 --formulamode option.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49 -f, --formulamode *DataField | StructureData*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 Specify source of molecular formula used for performing elemental
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 analysis: retrieve formula using *SDFile(s)* data field name or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52 generate formula from structure. Possible values: *DataField or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 StructureData*. Default value: *DataField*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 --formulaout *yes or no*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56 Specify whether to write out formula to SD file during
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57 *StructureData* value of -f, --formulamode option. Possible values:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58 *Yes or No*. Default: *No*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60 -m, --mode *All | "ElementalAnalysis,[MolecularWeight,ExactMass]"*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 Specify what values to calculate using molecular formula data field
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 or structure data from *SDFile(s)*: calculate all supported values
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63 or specify a comma delimited list of values. Possible values: *All |
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64 "ElementalAnalysis, [MolecularWeight, ExactMass]"*. Default: *All*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66 -h, --help
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67 Print this help message.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69 -o, --overwrite
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70 Overwrite existing files.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 -p, --precision *number*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73 Precision of calculated values in the output file. Default: up to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 *2* decimal places. Valid values: positive integers.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 -r, --root *rootname*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77 New SD file name is generated using the root: <Root>.<Ext>. Default
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78 new file name: <InitialSDFileName>ElementalAnalysis.<Ext>. This
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79 option is ignored for multiple input files.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 -v --valuefieldnames *Name,Label,[Name,Label,...]*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82 Specify SD data field names to use for calculated values. In
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83 general, it's a comma delimited list of value name and SD field name
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84 pairs. Supported value names: *ElementalAnalysis, MolecularWeight,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85 ExactMass, and MolecularFormula*. Default labels:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 *ElementalAnalysis, MolecularWeight, ExactMass, and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87 MolecularFormula*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89 *MolecularFormula* label is only used during *StructureData* value
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
90 of -f, --formulamode option.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
91
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
92 -w, --workingdir *dirname*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
93 Location of working directory. Default: current directory.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
94
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
95 EXAMPLES
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
96 To perform elemental analysis, calculate molecular weight and exact mass
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
97 using SD field name value with the word Formula in its name and generate
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
98 a new SD file NewSample1.sdf, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
99
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
100 % ElementalAnalysisSDFiles.pl -o -r NewSample1 Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
101
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
102 To perform elemental analysis, calculate molecular weight and exact mass
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
103 using structure data in SD file and generate a new SD file
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
104 NewSample1.sdf, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
105
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
106 % ElementalAnalysisSDFiles.pl --formulamode StructureData -o
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
107 -r NewSample1 Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
108
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
109 To perform elemental analysis using formulas in SD field name Formula,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
110 use field name Analysis for calculated data, and generate a new SD file
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
111 NewSample1.sdf, type:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
112
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
113 % ElementalAnalysisSDFiles.pl --m ElementalAnalysis --formulafield
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
114 Formula --valuefieldnames "ElementalAnalysis,Analysis" -o
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
115 -r NewSample1 Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
116
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
117 To calculate molecular weight, using formulas in SD field name Formula,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
118 with four decimal precision and generate a new SD file NewSample1.sdf,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
119 type
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
120
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
121 % ElementalAnalysisSDFiles.pl --m MolecularWeight --formulafield
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
122 Formula --precision 4 -o -r NewSample1 Sample1.sdf
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
123
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
124 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
125 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
126
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
127 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
128 AnalyzeSDFilesData.pl, InfoSDFiles.pl, ExtractFromSDFiles.pl
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
129
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
130 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
131 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
132
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
133 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
134
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
135 MayaChemTools is free software; you can redistribute it and/or modify it
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
136 under the terms of the GNU Lesser General Public License as published by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
137 the Free Software Foundation; either version 3 of the License, or (at
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
138 your option) any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
139