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