| 1 | package Bio::Phylo::Models::Substitution::Dna::F81; | ||
| 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::F81 - Felsenstein (1981) model | ||
| 9 | |||
| 10 | =head1 DESCRIPTION | ||
| 11 | |||
| 12 | See L<Bio::Phylo::Models::Substitution::Dna> | ||
| 13 | |||
| 14 | =head1 METHODS | ||
| 15 | |||
| 16 | =over | ||
| 17 | |||
| 18 | =item get_rate | ||
| 19 | |||
| 20 | Getter for substitution rate. If bases are given as arguments, | ||
| 21 | returns corresponding rate. If no arguments given, returns rate matrix or | ||
| 22 | overall rate, dependent on model. | ||
| 23 | |||
| 24 | Type : method | ||
| 25 | Title : get_rate | ||
| 26 | Usage : $model->get_rate('A', 'C'); | ||
| 27 | Function: Getter for transition rate between nucleotides. | ||
| 28 | Returns : scalar or array | ||
| 29 | Args : Optional: | ||
| 30 | base1: scalar | ||
| 31 | base2: scalar | ||
| 32 | |||
| 33 | =cut | ||
| 34 | |||
| 35 | # subst rate | ||
| 36 | sub get_rate { | ||
| 37 | my $self = shift; | ||
| 38 | return $self->get_pi(shift); | ||
| 39 | } | ||
| 40 | |||
| 41 | =item get_nst | ||
| 42 | |||
| 43 | Getter for number of transition rate parameters. | ||
| 44 | |||
| 45 | Type : method | ||
| 46 | Title : get_nst | ||
| 47 | Usage : $model->get_nst; | ||
| 48 | Function: Getter for number of transition rate parameters. | ||
| 49 | Returns : scalar | ||
| 50 | Args : None. | ||
| 51 | |||
| 52 | =cut | ||
| 53 | |||
| 54 | sub get_nst { 1 } | ||
| 55 | |||
| 56 | =back | ||
| 57 | |||
| 58 | =head1 SEE ALSO | ||
| 59 | |||
| 60 | There is a mailing list at L<https://groups.google.com/forum/#!forum/bio-phylo> | ||
| 61 | for any user or developer questions and discussions. | ||
| 62 | |||
| 63 | =over | ||
| 64 | |||
| 65 | =item L<Bio::Phylo::Manual> | ||
| 66 | |||
| 67 | Also see the manual: L<Bio::Phylo::Manual> and L<http://rutgervos.blogspot.com>. | ||
| 68 | |||
| 69 | =back | ||
| 70 | |||
| 71 | =head1 CITATION | ||
| 72 | |||
| 73 | If you use Bio::Phylo in published research, please cite it: | ||
| 74 | |||
| 75 | B<Rutger A Vos>, B<Jason Caravas>, B<Klaas Hartmann>, B<Mark A Jensen> | ||
| 76 | and B<Chase Miller>, 2011. Bio::Phylo - phyloinformatic analysis using Perl. | ||
| 77 | I<BMC Bioinformatics> B<12>:63. | ||
| 78 | L<http://dx.doi.org/10.1186/1471-2105-12-63> | ||
| 79 | |||
| 80 | =cut | ||
| 81 | |||
| 82 | 1; |