|
1
|
1 NAME
|
|
|
2 NucleicAcids
|
|
|
3
|
|
|
4 SYNOPSIS
|
|
|
5 use NucleicAcids;
|
|
|
6
|
|
|
7 use NucleicAcids qw(:all);
|
|
|
8
|
|
|
9 DESCRIPTION
|
|
|
10 NucleicAcids module the provides the following functions:
|
|
|
11
|
|
|
12 GetNucleicAcidPropertiesData, GetNucleicAcidPropertiesNames,
|
|
|
13 GetNucleicAcids, GetNucleicAcidsByType, IsNucleicAcid,
|
|
|
14 IsNucleicAcidProperty, IsNucleicAcidType
|
|
|
15
|
|
|
16 Functions
|
|
|
17 GetNucleicAcids
|
|
|
18 (@Names) = GetNucleicAcids([$NameType]);
|
|
|
19 $NamesRef = GetNucleicAcids([$NameType]);
|
|
|
20
|
|
|
21 Returns an array or a reference to an array containing names of
|
|
|
22 nucleic acids as a code or nucleic acid name controlled by optional
|
|
|
23 parameter *NameType*. By default, nucleic acids names are returned
|
|
|
24 as the code. Possible values for *NameType*: *Code or Name*.
|
|
|
25
|
|
|
26 GetNucleicAcidsByType
|
|
|
27 (@Names) = GetNucleicAcidsByType([$Type, $NameType]);
|
|
|
28 $NamesRef = GetNucleicAcidsByType([$Type, $NameType]);
|
|
|
29
|
|
|
30 Returns an array or a reference to an array containing names of
|
|
|
31 nucleic acids specified by parameter *Type* as a code or name
|
|
|
32 controlled by optional parameter *NameType*. Default values for
|
|
|
33 *Type*: *Nucleoside*. Default value for *NameType*: *Code*. Possible
|
|
|
34 values for *Type*: *Nucleobase, Nucleoside, Deoxynucleoside,
|
|
|
35 Nucleotide, Deoxynucleotide*. Possible values for *NameType*: *Code
|
|
|
36 or Name*.
|
|
|
37
|
|
|
38 GetNucleicAcidPropertiesData
|
|
|
39 $DataHashRef = GetNucleicAcidPropertiesData($NucleicAcidID);
|
|
|
40
|
|
|
41 Returns a reference to hash containing property names and values for
|
|
|
42 a specified *NucleicAcidID*.
|
|
|
43
|
|
|
44 GetNucleicAcidPropertyName
|
|
|
45 $Value = GetNucleicAcid<PropertyName>($NucleicAcidID);
|
|
|
46
|
|
|
47 Returns nucleic acid property value for a specified *NucleicAcidID*.
|
|
|
48 This function is implemented on-the-fly using Perl's AUTOLOAD
|
|
|
49 functionality.
|
|
|
50
|
|
|
51 GetNucleicAcidPropertiesNames
|
|
|
52 @Names = GetNucleicAcidPropertiesNames([$Mode]);
|
|
|
53 $NamesRef = GetNucleicAcidPropertiesNames([$Mode]);
|
|
|
54
|
|
|
55 Returns an array or a reference to an array containing names of
|
|
|
56 properties for nucleic acids. Order of nucleic acids properties is
|
|
|
57 controlled by optional parameter *Mode*. Possible values for *Mode*:
|
|
|
58 *Alphabetical or ByGroup*; Default: *ByGroup*.
|
|
|
59
|
|
|
60 IsNucleicAcid
|
|
|
61 $Status = IsNucleicAcid($NucleicAcidID);
|
|
|
62
|
|
|
63 Returns 1 or 0 based on whether it's a known nucleic acid ID.
|
|
|
64
|
|
|
65 IsNucleicAcidProperty
|
|
|
66 $Status = IsNucleicAcid($PropertyName);
|
|
|
67
|
|
|
68 Returns 1 or 0 based on whether it's a known nucleic acid property
|
|
|
69 name.
|
|
|
70
|
|
|
71 IsNucleicAcidType
|
|
|
72 $Status = IsNucleicAcidType();
|
|
|
73
|
|
|
74 Returns 1 or 0 based on whether it's a known nucleic acid type.
|
|
|
75
|
|
|
76 AUTHOR
|
|
|
77 Manish Sud <msud@san.rr.com>
|
|
|
78
|
|
|
79 SEE ALSO
|
|
|
80 AminoAcids.pm, PeriodicTable.pm
|
|
|
81
|
|
|
82 COPYRIGHT
|
|
|
83 Copyright (C) 2015 Manish Sud. All rights reserved.
|
|
|
84
|
|
|
85 This file is part of MayaChemTools.
|
|
|
86
|
|
|
87 MayaChemTools is free software; you can redistribute it and/or modify it
|
|
|
88 under the terms of the GNU Lesser General Public License as published by
|
|
|
89 the Free Software Foundation; either version 3 of the License, or (at
|
|
|
90 your option) any later version.
|
|
|
91
|
