annotate lib/NucleicAcids.pm @ 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 package NucleicAcids;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
2 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3 # $RCSfile: NucleicAcids.pm,v $
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 # $Date: 2015/02/28 20:47:18 $
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 # $Revision: 1.25 $
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 # Author: Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 # Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11 # This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13 # MayaChemTools is free software; you can redistribute it and/or modify it under
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 # the terms of the GNU Lesser General Public License as published by the Free
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 # Software Foundation; either version 3 of the License, or (at your option) any
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 # later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 # MayaChemTools is distributed in the hope that it will be useful, but without
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 # any warranty; without even the implied warranty of merchantability of fitness
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 # for a particular purpose. See the GNU Lesser General Public License for more
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 # details.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 # You should have received a copy of the GNU Lesser General Public License
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 # along with MayaChemTools; if not, see <http://www.gnu.org/licenses/> or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25 # write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 # Boston, MA, 02111-1307, USA.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 use strict;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 use Carp;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31 use Text::ParseWords;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 use TextUtil;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 use FileUtil;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 @ISA = qw(Exporter);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 @EXPORT = qw();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 @EXPORT_OK = qw(GetNucleicAcids GetNucleicAcidsByType GetNucleicAcidPropertiesData GetNucleicAcidPropertiesNames IsNucleicAcid IsNucleicAcidProperty IsNucleicAcidType);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41 %EXPORT_TAGS = (all => [@EXPORT, @EXPORT_OK]);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44 # Load nucleic acids data...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46 my(%NucleicAcidDataMap, %NucleicAcidCodeMap, %NucleicAcidOtherCodeMap, %NucleicAcidNameMap, @NucleicAcidCodes, @NucleicAcidPropertyNames, %NucleicAcidPropertyNamesMap, %NucleicAcidTypesMap);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 _LoadNucleicAcidsData();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 # Get a list of all known nucleic acids as one of these values:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 # code or nucleic acid name...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 sub GetNucleicAcids {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54 my($NameType, $Code, $Name, @NucleicAcidNames);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56 $NameType = 'Code';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57 if (@_ >= 1) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58 ($NameType) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 # Collect names...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 @NucleicAcidNames = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63 for $Code (@NucleicAcidCodes) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64 NAME : {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65 if ($NameType =~ /^Name$/i) {$Name = $NucleicAcidDataMap{$Code}{Name}; last NAME; }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66 $Name = $Code;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68 push @NucleicAcidNames, $Name;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71 return (wantarray ? @NucleicAcidNames : \@NucleicAcidNames);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75 # Get a list of all known nucleic acids by one of these specified types:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 # Nucleobase, Nucleoside, Deoxynucleoside, Nucleotide, Deoxynucleotide. Default: Nucleoside
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78 sub GetNucleicAcidsByType {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79 my($NameType, $Type, $Code, $Name, @NucleicAcidNames);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 $Type = 'Nucleoside';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82 $NameType = 'Code';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83 if (@_ == 2) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84 ($Type, $NameType) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 elsif (@_ == 1) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87 ($Type) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
90 # Collect names...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
91 @NucleicAcidNames = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
92 CODE: for $Code (@NucleicAcidCodes) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
93 if ($NucleicAcidDataMap{$Code}{Type} !~ /^$Type$/i ) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
94 next CODE;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
95 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
96 NAME : {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
97 if ($NameType =~ /^Name$/i) {$Name = $NucleicAcidDataMap{$Code}{Name}; last NAME; }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
98 $Name = $Code;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
99 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
100 push @NucleicAcidNames, $Name;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
101 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
102
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
103 return (wantarray ? @NucleicAcidNames : \@NucleicAcidNames);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
104 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
105
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
106 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
107 # Get all available properties data for an nucleic acid using any of these symbols:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
108 # code, other code or name.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
109 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
110 # A reference to a hash array is returned with keys and values representing property
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
111 # name and its values respectively.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
112 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
113 sub GetNucleicAcidPropertiesData {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
114 my($NucleicAcidID) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
115 my($Code);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
116
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
117 if ($Code = _ValidateNucleicAcidID($NucleicAcidID)) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
118 return \%{$NucleicAcidDataMap{$Code}};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
119 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
120 else {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
121 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
122 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
123 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
124
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
125 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
126 # Get names of all available nucleic acid properties. A reference to an array containing
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
127 # names of all available properties is returned.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
128 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
129 sub GetNucleicAcidPropertiesNames {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
130 my($Mode);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
131 my($PropertyName, @PropertyNames);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
132
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
133 $Mode = 'ByGroup';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
134 if (@_ == 1) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
135 ($Mode) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
136 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
137
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
138 @PropertyNames = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
139 if ($Mode =~ /^Alphabetical$/i) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
140 my($PropertyName);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
141 # Code, OtherCodes and Name are always listed first...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
142 push @PropertyNames, qw(Code OtherCodes Name);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
143 for $PropertyName (sort keys %NucleicAcidPropertyNamesMap) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
144 if ($PropertyName !~ /^(Code|OtherCodes|Name)$/) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
145 push @PropertyNames, $PropertyName;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
146 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
147 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
148 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
149 else {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
150 push @PropertyNames, @NucleicAcidPropertyNames;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
151 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
152 return (wantarray ? @PropertyNames : \@PropertyNames);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
153 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
154
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
155 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
156 # Is it a known nucleic acid? Input is either a code or a name
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
157 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
158 sub IsNucleicAcid {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
159 my($NucleicAcidID) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
160 my($Status);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
161
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
162 $Status = (_ValidateNucleicAcidID($NucleicAcidID)) ? 1 : 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
163
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
164 return $Status;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
165 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
166
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
167 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
168 # Is it an available nucleic acid property?
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
169 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
170 sub IsNucleicAcidProperty {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
171 my($PropertyName) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
172 my($Status);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
173
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
174 $Status = (exists($NucleicAcidPropertyNamesMap{$PropertyName})) ? 1 : 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
175
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
176 return $Status;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
177 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
178
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
179 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
180 # Is it an available nucleic acid type?
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
181 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
182 sub IsNucleicAcidType {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
183 my($Type) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
184 my($Status);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
185
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
186 $Status = (exists($NucleicAcidTypesMap{lc($Type)})) ? 1 : 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
187
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
188 return $Status;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
189 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
190
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
191 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
192 # Implents GetNucleicAcid<PropertyName> for a valid proprty name.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
193 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
194 sub AUTOLOAD {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
195 my($NucleicAcidID) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
196 my($FunctionName, $PropertyName, $PropertyValue, $Code);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
197
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
198 $PropertyValue = undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
199
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
200 use vars qw($AUTOLOAD);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
201 $FunctionName = $AUTOLOAD;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
202 $FunctionName =~ s/.*:://;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
203
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
204 # Only Get<PropertyName> functions are supported...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
205 if ($FunctionName !~ /^Get/) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
206 croak "Error: Function, NucleicAcid::$FunctionName, is not supported by AUTOLOAD in NucleicAcid module: Only Get<PropertyName> functions are implemented...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
207 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
208
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
209 $PropertyName = $FunctionName;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
210 $PropertyName =~ s/^GetNucleicAcid//;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
211 if (!exists $NucleicAcidPropertyNamesMap{$PropertyName}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
212 croak "Error: Function, NucleicAcid::$FunctionName, is not supported by AUTOLOAD in NucleicAcid module: Unknown nucleic acid property name, $PropertyName, specified...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
213 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
214
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
215 if (!($Code = _ValidateNucleicAcidID($NucleicAcidID))) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
216 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
217 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
218 $PropertyValue = $NucleicAcidDataMap{$Code}{$PropertyName};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
219 return $PropertyValue;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
220 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
221
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
222 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
223 # Load NucleicAcidsData.csv files from <MayaChemTools>/lib directory...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
224 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
225 sub _LoadNucleicAcidsData {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
226 my($NucleicAcidsDataFile, $MayaChemToolsLibDir);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
227
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
228 $MayaChemToolsLibDir = GetMayaChemToolsLibDirName();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
229
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
230 $NucleicAcidsDataFile = "$MayaChemToolsLibDir" . "/data/NucleicAcidsData.csv";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
231
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
232 if (! -e "$NucleicAcidsDataFile") {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
233 croak "Error: MayaChemTools package file, $NucleicAcidsDataFile, is missing: Possible installation problems...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
234 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
235
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
236 _LoadData($NucleicAcidsDataFile);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
237 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
238
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
239 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
240 # Load NucleicAcidsData.csv file from <MayaChemTools>/lib directory...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
241 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
242 sub _LoadData {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
243 my($NucleicAcidsDataFile) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
244
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
245 %NucleicAcidDataMap = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
246 @NucleicAcidCodes = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
247 @NucleicAcidPropertyNames = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
248 %NucleicAcidPropertyNamesMap = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
249 %NucleicAcidCodeMap = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
250 %NucleicAcidOtherCodeMap = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
251 %NucleicAcidNameMap = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
252 %NucleicAcidTypesMap = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
253
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
254 # Load property data for all nucleic acids...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
255 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
256 # File Format:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
257 # "Code","OtherCodes","BasePair","Name","Type","ChemicalFormula","ChemicalFormulaAtpH7.5","MolecularWeight","ExactMass","ElementalComposition"
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
258 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
259 my($Code, $OtherCodes, $NucleicAcidName, $Line, $NumOfCols, $InDelim, $Index, $Name, $Value, $Units, @LineWords, @ColLabels);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
260
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
261 $InDelim = "\,";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
262 open NUCLEICACIDSDATAFILE, "$NucleicAcidsDataFile" or croak "Couldn't open $NucleicAcidsDataFile: $! ...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
263
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
264 # Skip lines up to column labels...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
265 LINE: while ($Line = GetTextLine(\*NUCLEICACIDSDATAFILE)) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
266 if ($Line !~ /^#/) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
267 last LINE;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
268 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
269 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
270 @ColLabels= quotewords($InDelim, 0, $Line);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
271 $NumOfCols = @ColLabels;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
272
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
273 # Extract property names from column labels...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
274 @NucleicAcidPropertyNames = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
275 for $Index (0 .. $#ColLabels) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
276 $Name = $ColLabels[$Index];
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
277 push @NucleicAcidPropertyNames, $Name;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
278
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
279 # Store property names...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
280 $NucleicAcidPropertyNamesMap{$Name} = $Name;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
281 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
282
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
283 # Process nucleic acid data...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
284 LINE: while ($Line = GetTextLine(\*NUCLEICACIDSDATAFILE)) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
285 if ($Line =~ /^#/) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
286 next LINE;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
287 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
288 @LineWords = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
289 @LineWords = quotewords($InDelim, 0, $Line);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
290 if (@LineWords != $NumOfCols) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
291 croak "Error: The number of data fields, @LineWords, in $NucleicAcidsDataFile must be $NumOfCols.\nLine: $Line...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
292 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
293 $Code = $LineWords[0]; $OtherCodes = $LineWords[1]; $NucleicAcidName = $LineWords[3];
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
294 if (exists $NucleicAcidDataMap{$Code}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
295 carp "Warning: Ignoring data for nucleic acid $Code: It has already been loaded.\nLine: $Line....";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
296 next LINE;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
297 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
298
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
299 # Store all the values...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
300 push @NucleicAcidCodes, $Code;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
301 %{$NucleicAcidDataMap{$Code}} = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
302 for $Index (0 .. $#LineWords) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
303 $Name = $NucleicAcidPropertyNames[$Index];
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
304 $Value = $LineWords[$Index];
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
305 $NucleicAcidDataMap{$Code}{$Name} = $Value;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
306 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
307 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
308 close NUCLEICACIDSDATAFILE;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
309
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
310 # Setup one letter and nucleic acid name maps...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
311 _SetupNucleicAcidIDMap();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
312 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
313
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
314 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
315 # Setup lowercase other codes and name maps pointing
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
316 # to code as show in data file.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
317 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
318 sub _SetupNucleicAcidIDMap {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
319 my($Code, @OtherCodes, $OtherCode, $NucleicAcidName, $NucleicAcidType);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
320
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
321 %NucleicAcidCodeMap = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
322 %NucleicAcidOtherCodeMap = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
323 %NucleicAcidNameMap = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
324 %NucleicAcidTypesMap = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
325
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
326 for $Code (keys %NucleicAcidDataMap) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
327 $NucleicAcidCodeMap{lc($Code)} = $Code;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
328
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
329 $NucleicAcidName = $NucleicAcidDataMap{$Code}{Name};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
330 $NucleicAcidNameMap{lc($NucleicAcidName)} = $Code;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
331
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
332 $NucleicAcidType = $NucleicAcidDataMap{$Code}{Type};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
333 if (! exists $NucleicAcidTypesMap{$NucleicAcidType}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
334 $NucleicAcidTypesMap{lc($NucleicAcidType)} = $NucleicAcidType;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
335 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
336
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
337 @OtherCodes = split /\,/, $NucleicAcidDataMap{$Code}{OtherCodes};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
338 OTHERCODE: for $OtherCode (@OtherCodes) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
339 if (!$OtherCode) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
340 next OTHERCODE;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
341 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
342 $OtherCode = RemoveLeadingAndTrailingWhiteSpaces($OtherCode);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
343 $NucleicAcidOtherCodeMap{lc($OtherCode)} = $Code;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
344 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
345 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
346 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
347
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
348 # Validate Nucleic acid ID...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
349 sub _ValidateNucleicAcidID {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
350 my($NucleicAcidID) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
351 my($Code) = undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
352
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
353 if (exists $NucleicAcidCodeMap{lc($NucleicAcidID)}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
354 $Code = $NucleicAcidCodeMap{lc($NucleicAcidID)};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
355 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
356 elsif (exists $NucleicAcidOtherCodeMap{lc($NucleicAcidID)}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
357 $Code = $NucleicAcidOtherCodeMap{lc($NucleicAcidID)};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
358 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
359 elsif (exists $NucleicAcidNameMap{lc($NucleicAcidID)}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
360 $Code = $NucleicAcidNameMap{lc($NucleicAcidID)};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
361 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
362 return $Code;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
363 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
364
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
365
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
366 1;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
367
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
368 __END__
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
369
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
370 =head1 NAME
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
371
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
372 NucleicAcids
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
373
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
374 =head1 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
375
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
376 use NucleicAcids;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
377
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
378 use NucleicAcids qw(:all);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
379
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
380 =head1 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
381
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
382 B<NucleicAcids> module the provides the following functions:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
383
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
384 GetNucleicAcidPropertiesData, GetNucleicAcidPropertiesNames,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
385 GetNucleicAcids, GetNucleicAcidsByType, IsNucleicAcid, IsNucleicAcidProperty,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
386 IsNucleicAcidType
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
387
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
388 =head1 Functions
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
389
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
390 =over 4
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
391
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
392 =item B<GetNucleicAcids>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
393
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
394 (@Names) = GetNucleicAcids([$NameType]);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
395 $NamesRef = GetNucleicAcids([$NameType]);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
396
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
397 Returns an array or a reference to an array containing names of nucleic acids
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
398 as a code or nucleic acid name controlled by optional parameter I<NameType>. By
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
399 default, nucleic acids names are returned as the code. Possible values for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
400 I<NameType>: I<Code or Name>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
401
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
402 =item B<GetNucleicAcidsByType>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
403
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
404 (@Names) = GetNucleicAcidsByType([$Type, $NameType]);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
405 $NamesRef = GetNucleicAcidsByType([$Type, $NameType]);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
406
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
407 Returns an array or a reference to an array containing names of nucleic acids
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
408 specified by parameter I<Type> as a code or name controlled by optional
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
409 parameter I<NameType>. Default values for I<Type>: I<Nucleoside>. Default value for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
410 I<NameType>: I<Code>. Possible values for I<Type>: I<Nucleobase, Nucleoside, Deoxynucleoside,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
411 Nucleotide, Deoxynucleotide>. Possible values for I<NameType>: I<Code or Name>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
412
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
413 =item B<GetNucleicAcidPropertiesData>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
414
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
415 $DataHashRef = GetNucleicAcidPropertiesData($NucleicAcidID);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
416
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
417 Returns a reference to hash containing property names and values for a specified
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
418 I<NucleicAcidID>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
419
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
420 =item B<GetNucleicAcidPropertyName>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
421
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
422 $Value = GetNucleicAcid<PropertyName>($NucleicAcidID);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
423
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
424 Returns nucleic acid property value for a specified I<NucleicAcidID>. This function is
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
425 implemented on-the-fly using Perl's AUTOLOAD functionality.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
426
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
427 =item B<GetNucleicAcidPropertiesNames>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
428
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
429 @Names = GetNucleicAcidPropertiesNames([$Mode]);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
430 $NamesRef = GetNucleicAcidPropertiesNames([$Mode]);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
431
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
432 Returns an array or a reference to an array containing names of properties for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
433 nucleic acids. Order of nucleic acids properties is controlled by optional parameter
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
434 I<Mode>. Possible values for I<Mode>: I<Alphabetical or ByGroup>; Default: I<ByGroup>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
435
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
436 =item B<IsNucleicAcid>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
437
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
438 $Status = IsNucleicAcid($NucleicAcidID);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
439
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
440 Returns 1 or 0 based on whether it's a known nucleic acid ID.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
441
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
442 =item B<IsNucleicAcidProperty>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
443
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
444 $Status = IsNucleicAcid($PropertyName);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
445
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
446 Returns 1 or 0 based on whether it's a known nucleic acid property name.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
447
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
448 =item B<IsNucleicAcidType>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
449
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
450 $Status = IsNucleicAcidType();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
451
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
452 Returns 1 or 0 based on whether it's a known nucleic acid type.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
453
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
454 =back
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
455
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
456 =head1 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
457
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
458 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
459
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
460 =head1 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
461
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
462 AminoAcids.pm, PeriodicTable.pm
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
463
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
464 =head1 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
465
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
466 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
467
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
468 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
469
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
470 MayaChemTools is free software; you can redistribute it and/or modify it under
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
471 the terms of the GNU Lesser General Public License as published by the Free
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
472 Software Foundation; either version 3 of the License, or (at your option)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
473 any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
474
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
475 =cut