Phylo/Models/Substitution/Dna/JC69.pm untested

filter: Statementstmt 0.0% 0 / 12 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 7 Podpod 0.0% 0 / 4 totaltotal 0.0% 0 / 23 CC 1 SCAR 6.9
CC
1
Cov
0%
get_nst
2.0
get_rate
2.0
get_catweights
2.0
CRAP 2.0
1 package Bio::Phylo::Models::Substitution::Dna::JC69;
2 use strict;
3 use warnings;
4 use base 'Bio::Phylo::Models::Substitution::Dna';
5  
6 =head1 NAME
7  
8 Bio::Phylo::Models::Substitution::Dna::JC69 - Jukes, Cantor (1969)
9  
10 =head1 DESCRIPTION
11  
12 See L<Bio::Phylo::Models::Substitution::Dna>
13  
14 =head1 METHODS
15  
16 =over
17  
18 =item get_nst
19  
20 Getter for number of transition rate parameters.
21  
22 Type : method
23 Title : get_nst
24 Usage : $model->get_nst;
25 Function: Getter for number of transition rate parameters.
26 Returns : scalar
27 Args : None.
28  
29 =cut
30  
31 sub get_nst { 1 }
32  
33 =item get_rate
34  
35 Getter for substitution rate. If bases are given as arguments,
36 returns corresponding rate. If no arguments given, returns rate matrix or
37 overall rate, dependent on model.
38  
39 Type : method
40 Title : get_rate
41 Usage : $model->get_rate('A', 'C');
42 Function: Getter for transition rate between nucleotides.
43 Returns : scalar or array
44 Args : Optional:
45 base1: scalar
46 base2: scalar
47  
48 =cut
49  
50 # substitution rate
51 sub get_rate { shift->get_mu / 4 }
52  
53 =item get_catweights
54  
55 Getter for weights on rate categories.
56  
57 Type : method
58 Title : get_catweights
59 Usage : $model->get_catweights;
60 Function: Getter for number of rate categories.
61 Returns : array
62 Args : None
63  
64 =cut
65  
66 sub get_catweights { [1.0] }
67  
68 =item get_catrates
69  
70 Getter for rate categories, implemented by child classes.
71  
72 Type : method
73 Title : get_catrates
74 Usage : $model->get_catrates;
75 Function: Getter for rate categories.
76 Returns : scalar or array
77 Args : None.
78  
79 =cut
80  
81 sub get_catrates { [1.0] }
82  
83 =back
84  
85 =head1 SEE ALSO
86  
87 There is a mailing list at L<https://groups.google.com/forum/#!forum/bio-phylo>
88 for any user or developer questions and discussions.
89  
90 =over
91  
92 =item L<Bio::Phylo::Manual>
93  
94 Also see the manual: L<Bio::Phylo::Manual> and L<http://rutgervos.blogspot.com>.
95  
96 =back
97  
98 =head1 CITATION
99  
100 If you use Bio::Phylo in published research, please cite it:
101  
102 B<Rutger A Vos>, B<Jason Caravas>, B<Klaas Hartmann>, B<Mark A Jensen>
103 and B<Chase Miller>, 2011. Bio::Phylo - phyloinformatic analysis using Perl.
104 I<BMC Bioinformatics> B<12>:63.
105 L<http://dx.doi.org/10.1186/1471-2105-12-63>
106  
107 =cut
108  
109 1;