annotate docs/modules/txt/SLogPAndSMRDescriptors.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 SLogPAndSMRDescriptors
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 use MolecularDescriptors::SLogPAndSMRDescriptors;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 use MolecularDescriptors::SLogPAndSMRDescriptors qw(:all);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 SLogPAndSMRDescriptors class provides the following methods:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 new, GenerateDescriptors, GetDescriptorNames,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13 StringifySLogPAndSMRDescriptors
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 SLogPAndSMRDescriptors is derived from MolecularDescriptors class which
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 in turn is derived from ObjectProperty base class that provides methods
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 not explicitly defined in SLogPAndSMRDescriptors, MolecularDescriptors
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 or ObjectProperty classes using Perl's AUTOLOAD functionality. These
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 methods are generated on-the-fly for a specified object property:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 Set<PropertyName>(<PropertyValue>);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 $PropertyValue = Get<PropertyName>();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 Delete<PropertyName>();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25 After SLogP atom types [ Ref 89 ] has been assigned to all atoms in a
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 molecule using AtomTypes::SLogPAndSMR.pm module, SLogP (calculated logP)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 and SMR (calculated molar refractivity) values are calculated by adding
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28 up LogP and MR contributions of each atom type.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 METHODS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31 new
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 $NewSLogPAndSMRDescriptors = new MolecularDescriptors::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 SLogPAndSMRDescriptors(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34 %NamesAndValues);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36 Using specified *SLogPAndSMRDescriptors* property names and values
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 hash, new method creates a new object and returns a reference to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 newly created SLogPAndSMRDescriptors object. By default, the
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 following properties are initialized:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41 Molecule = ''
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 Type = 'SLogPAndSMR'
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 @DescriptorNames = ('SLogP', 'SMR')
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44 @DescriptorValues = ('None', 'None')
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46 Examples:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48 $SLogPAndSMRDescriptors = new MolecularDescriptors::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49 SLogPAndSMRDescriptors();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 $SLogPAndSMRDescriptors->SetMolecule($Molecule);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52 $SLogPAndSMRDescriptors->GenerateDescriptors();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 print "SLogPAndSMRDescriptors: $SLogPAndSMRDescriptors\n";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 GenerateDescriptors
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56 $SLogPAndSMRDescriptors->GenerateDescriptors();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58 Calculate SLogP and SMR values for a molecule and returns
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59 *SLogPAndSMRDescriptors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 GetDescriptorNames
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 @DescriptorNames = $SLogPAndSMRDescriptors->GetDescriptorNames();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63 @DescriptorNames = MolecularDescriptors::SLogPAndSMRDescriptors::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64 GetDescriptorNames();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66 Returns all available descriptor names as an array.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68 StringifySLogPAndSMRDescriptors
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69 $String = $SLogPAndSMRDescriptors->StringifySLogPAndSMRDescriptors();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71 Returns a string containing information about
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 *SLogPAndSMRDescriptors* object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78 MolecularDescriptors.pm, MolecularDescriptorsGenerator.pm
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85 MayaChemTools is free software; you can redistribute it and/or modify it
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 under the terms of the GNU Lesser General Public License as published by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87 the Free Software Foundation; either version 3 of the License, or (at
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88 your option) any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89