annotate variant_effect_predictor/Bio/EnsEMBL/Variation/StructuralVariation.pm @ 3:d30fa12e4cc5 default tip

Merge heads 2:a5976b2dce6f and 1:09613ce8151e which were created as a result of a recently fixed bug.
author devteam <devteam@galaxyproject.org>
date Mon, 13 Jan 2014 10:38:30 -0500
parents 1f6dce3d34e0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1 =head1 LICENSE
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
2
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
3 Copyright (c) 1999-2012 The European Bioinformatics Institute and
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
4 Genome Research Limited. All rights reserved.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
5
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
6 This software is distributed under a modified Apache license.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
7 For license details, please see
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
8
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
9 http://www.ensembl.org/info/about/code_licence.html
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
10
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
11 =head1 CONTACT
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
12
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
13 Please email comments or questions to the public Ensembl
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
14 developers list at <dev@ensembl.org>.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
15
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
16 Questions may also be sent to the Ensembl help desk at
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
17 <helpdesk@ensembl.org>.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
18
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
19 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
20
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
21 # Ensembl module for Bio::EnsEMBL::Variation::StructuralVariation
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
22 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
23 # Copyright (c) 2004 Ensembl
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
24 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
25
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
26
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
27 =head1 NAME
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29 Bio::EnsEMBL::Variation::StructuralVariation - Ensembl representation of a structural variation.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31 =head1 SYNOPSIS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33 # Structural variation representing a CNV
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34 $sv = Bio::EnsEMBL::Variation::StructuralVariation->new
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35 (-variation_name => 'esv25480',
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36 -class_so_term => 'structural_variant',
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37 -source => 'DGVa',
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38 -source_description => 'Database of Genomic Variants Archive',
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39 -study_name => 'estd20',
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40 -study_description => 'Conrad 2009 "Origins and functional impact of copy number variation in the human genome." PMID:19812545 [remapped from build NCBI36]',
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41 -study_url => 'ftp://ftp.ebi.ac.uk/pub/databases/dgva/estd20_Conrad_et_al_2009',
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42 -external_reference => 'pubmed/19812545');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44 ...
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46 print $sv->name(), ":", $sv->var_class();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48 =head1 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50 This is a class representing a structural variation from the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51 ensembl-variation database. A structural variant may have a copy number variation, a tandem duplication,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52 an inversion of the sequence or others structural variations.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54 The position of a StructuralVariation object on the Genome is represented
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55 by the <Bio::EnsEMBL::Variation::StructuralVariationFeature> class.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57 =head1 METHODS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61 use strict;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62 use warnings;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64 package Bio::EnsEMBL::Variation::StructuralVariation;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66 use Bio::EnsEMBL::Variation::BaseStructuralVariation;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68 our @ISA = ('Bio::EnsEMBL::Variation::BaseStructuralVariation');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71 sub new {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72 my $caller = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73 my $class = ref($caller) || $caller;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75 my $self = Bio::EnsEMBL::Variation::BaseStructuralVariation->new(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76 return(bless($self, $class));
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79 =head2 get_all_SupportingStructuralVariants
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81 Example : $sv->get_all_SupportingStructuralVariants();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82 Description : Retrieves all SupportingStructuralVariation associated with this structural variation.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83 Return empty list if there are none.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84 Returntype : reference to list of Bio::EnsEMBL::Variation::SupportingStructuralVariation objects
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85 Exceptions : None
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87 Status : At Risk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91 sub get_all_SupportingStructuralVariants {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94 if (defined ($self->{'adaptor'})){
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95 my $ssv_adaptor = $self->{'adaptor'}->db()->get_SupportingStructuralVariationAdaptor();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96 return $ssv_adaptor->fetch_all_by_StructuralVariation($self);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98 warn("No variation database attached");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99 return [];
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
103 =head2 summary_as_hash
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
104
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
105 Example : $sv_summary = $sv->summary_as_hash();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
106 Description : Retrieves a textual summary of this StructuralVariation object.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
107 Returns : hashref of descriptive strings
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
108
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
109 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
110
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
111 sub summary_as_hash {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
112 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
113 my %summary;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
114 $summary{'display_id'} = $self->display_id;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
115 $summary{'study_name'} = $self->study_name;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
116 $summary{'study_description'} = $self->study_description;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
117 $summary{'class'} = $self->var_class;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
118 return \%summary;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
119
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
120 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
121
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
122 1;