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

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