| 1 | |||
| 2 | =head1 NAME | ||
| 3 | |||
| 4 | Bio::Matrix::PSM::InstanceSiteI - InstanceSite interface, holds an instance of a PSM | ||
| 5 | |||
| 6 | =head1 SYNOPSIS | ||
| 7 | |||
| 8 | use Bio::Matrix::PSM::InstanceSite; | ||
| 9 | #Y ou can get an InstanceSite object either from a file: | ||
| 10 | my ($instances,$matrix)=$SomePSMFile->parse_next; | ||
| 11 | #or from memory | ||
| 12 | my %params=(seq => 'TATAAT', | ||
| 13 | id => "TATAbox1", | ||
| 14 | accession => 'ENSG00000122304', | ||
| 15 | mid => 'TB1', | ||
| 16 | desc => 'TATA box, experimentally verified in PRM1 gene', | ||
| 17 | relpos => -35); | ||
| 18 | |||
| 19 | =head1 DESCRIPTION | ||
| 20 | |||
| 21 | Abstract interface to PSM site occurrence (PSM sequence | ||
| 22 | match). InstanceSite objects may be used to describe a PSM (See | ||
| 23 | Bio::Matrix::PSM::SiteMatrix) sequence matches. The usual | ||
| 24 | characteristic of such a match is sequence coordinates, score, | ||
| 25 | sequence and sequence (gene) identifier- accession number or other | ||
| 26 | id. This object inherits from Bio::LocatableSeq (which defines the | ||
| 27 | real sequence) and might hold a SiteMatrix object, used to detect the | ||
| 28 | CRE (cis-regulatory element), or created from this CRE. While the | ||
| 29 | documentation states that the motif id and gene id (accession) | ||
| 30 | combination should be unique, this is not entirely true- there might | ||
| 31 | be more than one occurrence of the same cis-regulatory element in the | ||
| 32 | upstream region of the same gene. Therefore relpos would be the third | ||
| 33 | element to create a really unique combination. | ||
| 34 | |||
| 35 | =head1 FEEDBACK | ||
| 36 | |||
| 37 | =head2 Mailing Lists | ||
| 38 | |||
| 39 | User feedback is an integral part of the evolution of this and other | ||
| 40 | Bioperl modules. Send your comments and suggestions preferably to one | ||
| 41 | of the Bioperl mailing lists. Your participation is much appreciated. | ||
| 42 | |||
| 43 | bioperl-l@bioperl.org - General discussion | ||
| 44 | http://bioperl.org/wiki/Mailing_lists - About the mailing lists | ||
| 45 | |||
| 46 | =head2 Support | ||
| 47 | |||
| 48 | Please direct usage questions or support issues to the mailing list: | ||
| 49 | |||
| 50 | I<bioperl-l@bioperl.org> | ||
| 51 | |||
| 52 | rather than to the module maintainer directly. Many experienced and | ||
| 53 | reponsive experts will be able look at the problem and quickly | ||
| 54 | address it. Please include a thorough description of the problem | ||
| 55 | with code and data examples if at all possible. | ||
| 56 | |||
| 57 | =head2 Reporting Bugs | ||
| 58 | |||
| 59 | Report bugs to the Bioperl bug tracking system to help us keep track | ||
| 60 | the bugs and their resolution. Bug reports can be submitted via the | ||
| 61 | web: | ||
| 62 | |||
| 63 | https://github.com/bioperl/bioperl-live/issues | ||
| 64 | |||
| 65 | =head1 AUTHOR - Stefan Kirov | ||
| 66 | |||
| 67 | Email skirov@utk.edu | ||
| 68 | |||
| 69 | =head1 SEE ALSO | ||
| 70 | |||
| 71 | L<Bio::Matrix::PSM::SiteMatrix>, L<Bio::Matrix::PSM::Psm>, L<Bio::Matrix::PSM::IO> | ||
| 72 | |||
| 73 | =head1 APPENDIX | ||
| 74 | |||
| 75 | =cut | ||
| 76 | |||
| 77 | |||
| 78 | # Let the code begin... | ||
| 79 | package Bio::Matrix::PSM::InstanceSiteI; | ||
| 80 | 14 | $Bio::Matrix::PSM::InstanceSiteI::VERSION = '1.7.8'; | |
| 81 | 14 | ▶ | use strict; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 82 | |||
| 83 | 14 | ▶ | use base qw(Bio::Root::RootI); |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 84 | |||
| 85 | =head2 mid | ||
| 86 | |||
| 87 | Title : mid | ||
| 88 | Usage : my $mid=$instance->mid; | ||
| 89 | Function: Get/Set the motif id | ||
| 90 | Throws : | ||
| 91 | Returns : scalar | ||
| 92 | Args : scalar | ||
| 93 | |||
| 94 | |||
| 95 | =cut | ||
| 96 | |||
| 97 | 0 | ▶ | sub mid { |
|
Subroutine
mid: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 98 | 0 | my $self = shift; | |
| 99 | 0 | $self->throw_not_implemented(); | |
| 100 | } | ||
| 101 | |||
| 102 | =head2 score | ||
| 103 | |||
| 104 | Title : score | ||
| 105 | Usage : my $score=$instance->score; | ||
| 106 | Function: Get/Set the score (mismatches) between the instance and the attached (or | ||
| 107 | initial) PSM | ||
| 108 | Throws : | ||
| 109 | Returns : real number | ||
| 110 | Args : real number | ||
| 111 | |||
| 112 | =cut | ||
| 113 | |||
| 114 | 0 | ▶ | sub score { |
|
Subroutine
score: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 115 | 0 | my $self = shift; | |
| 116 | 0 | $self->throw_not_implemented(); | |
| 117 | } | ||
| 118 | |||
| 119 | =head2 start | ||
| 120 | |||
| 121 | Title : start | ||
| 122 | Usage : my $start=$instance->start; | ||
| 123 | Function: Get/Set the position of the instance on the sequence used | ||
| 124 | Throws : | ||
| 125 | Returns : integer | ||
| 126 | Args : integer | ||
| 127 | |||
| 128 | =cut | ||
| 129 | |||
| 130 | 0 | ▶ | sub start { |
|
Subroutine
start: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 131 | 0 | my $self = shift; | |
| 132 | 0 | $self->throw_not_implemented(); | |
| 133 | } | ||
| 134 | |||
| 135 | =head2 relpos | ||
| 136 | |||
| 137 | Title : relpos | ||
| 138 | Usage : my $seqpos=$instance->relpos; | ||
| 139 | Function: Get/Set the relative position of the instance with respect to the transcription start | ||
| 140 | site (if known). Can and usually is negative. | ||
| 141 | Throws : | ||
| 142 | Returns : integer | ||
| 143 | Args : integer | ||
| 144 | |||
| 145 | =cut | ||
| 146 | |||
| 147 | 0 | ▶ | sub relpos { |
|
Subroutine
relpos: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 148 | 0 | my $self = shift; | |
| 149 | 0 | $self->throw_not_implemented(); | |
| 150 | } | ||
| 151 | |||
| 152 | |||
| 153 | =head2 minstance | ||
| 154 | |||
| 155 | Title : minstance | ||
| 156 | Usage : my $minstance=$misntance->score; | ||
| 157 | Function: Get/Set the unique identifier- sequence id/motif id, for example PRM1_TATAbox. | ||
| 158 | Not necessarily human readable. | ||
| 159 | Throws : | ||
| 160 | Returns : string | ||
| 161 | Args : string | ||
| 162 | |||
| 163 | =cut | ||
| 164 | |||
| 165 | 0 | ▶ | sub minstance { |
|
Subroutine
minstance: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 166 | 0 | my $self = shift; | |
| 167 | 0 | $self->throw_not_implemented(); | |
| 168 | } | ||
| 169 | |||
| 170 | |||
| 171 | 14 | 1; | |