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