t/Annotation.t

   1 # -*-Perl-*-
   2 ## Bioperl Test Harness Script for Modules
   3 ## $Id$
   4
   5 # Before `make install' is performed this script should be runnable with
   6 # `make test'. After `make install' it should work as `perl test.t'
   7
   8 use strict;
   9 use vars qw($HAVEGRAPHDIRECTED $DEBUG $NUMTESTS);
  10 $DEBUG = $ENV{'BIOPERLDEBUG'} || 0;
  11
  12 BEGIN {
  13     eval { require Test::More; };
  14     if( $@ ) {
  15                 use lib 't/lib';
  16     }
  17     use Test::More;
  18     plan tests => ($NUMTESTS = 108);
  19         use_ok('Bio::Annotation::Collection');
  20         use_ok('Bio::Annotation::DBLink');
  21         use_ok('Bio::Annotation::Comment');
  22         use_ok('Bio::Annotation::Reference');
  23         use_ok('Bio::Annotation::SimpleValue');
  24         use_ok('Bio::Annotation::Target');
  25         use_ok('Bio::Annotation::AnnotationFactory');
  26         use_ok('Bio::Annotation::StructuredValue');
  27         use_ok('Bio::Annotation::Tree');
  28         use_ok('Bio::Seq');
  29         use_ok('Bio::SeqFeature::Generic');
  30         use_ok('Bio::SimpleAlign');
  31         use_ok('Bio::Cluster::UniGene');
  32 }
  33
  34 #simple value
  35
  36 my $simple = Bio::Annotation::SimpleValue->new(
  37                                                   -tagname => 'colour',
  38                                                   -value   => '1'
  39                                                  ), ;
  40
  41 isa_ok($simple, 'Bio::AnnotationI');
  42 is $simple, 1;
  43 is $simple->value, 1;
  44 is $simple->tagname, 'colour';
  45
  46 is $simple->value(0), 0;
  47 is $simple->value, 0;
  48 is $simple, 0;
  49
  50 # link
  51
  52 my $link1 = new Bio::Annotation::DBLink(-database => 'TSC',
  53                                         -primary_id => 'TSC0000030'
  54                                         );
  55 isa_ok($link1,'Bio::AnnotationI');
  56 is $link1->database(), 'TSC';
  57 is $link1->primary_id(), 'TSC0000030';
  58 is $link1->as_text, 'Direct database link to TSC0000030 in database TSC';
  59 my $ac = Bio::Annotation::Collection->new();
  60 isa_ok($ac,'Bio::AnnotationCollectionI');
  61
  62 $ac->add_Annotation('dblink',$link1);
  63 $ac->add_Annotation('dblink',
  64                     Bio::Annotation::DBLink->new(-database => 'TSC',
  65                                                  -primary_id => 'HUM_FABV'));
  66
  67 my $comment = Bio::Annotation::Comment->new( '-text' => 'sometext');
  68 is $comment->text, 'sometext';
  69 is $comment->as_text, 'Comment: sometext';
  70 $ac->add_Annotation('comment', $comment);
  71
  72
  73
  74 my $target = new Bio::Annotation::Target(-target_id  => 'F321966.1',
  75                                          -start      => 1,
  76                                          -end        => 200,
  77                                          -strand     => 1,
  78                                          );
  79 isa_ok($target,'Bio::AnnotationI');
  80 ok $ac->add_Annotation('target', $target);
  81
  82
  83 my $ref = Bio::Annotation::Reference->new( '-authors' => 'author line',
  84                                            '-title'   => 'title line',
  85                                            '-location'=> 'location line',
  86                                            '-start'   => 12);
  87 isa_ok($ref,'Bio::AnnotationI');
  88 is $ref->authors, 'author line';
  89 is $ref->title,  'title line';
  90 is $ref->location, 'location line';
  91 is $ref->start, 12;
  92 is $ref->database, 'MEDLINE';
  93 is $ref->as_text, 'Reference: title line';
  94 $ac->add_Annotation('reference', $ref);
  95
  96
  97 my $n = 0;
  98 foreach my $link ( $ac->get_Annotations('dblink') ) {
  99     is $link->database, 'TSC';
 100     is $link->tagname(), 'dblink';
 101     $n++;
 102 }
 103 is ($n, 2);
 104
 105 $n = 0;
 106 my @keys = $ac->get_all_annotation_keys();
 107 is (scalar(@keys), 4);
 108 foreach my $ann ( $ac->get_Annotations() ) {
 109     shift(@keys) if ($n > 0) && ($ann->tagname ne $keys[0]);
 110     is $ann->tagname(), $keys[0];
 111     $n++;
 112 }
 113 is ($n, 5);
 114
 115 $ac->add_Annotation($link1);
 116
 117 $n = 0;
 118 foreach my $link ( $ac->get_Annotations('dblink') ) {
 119     is $link->tagname(), 'dblink';
 120     $n++;
 121 }
 122 is ($n, 3);
 123
 124 # annotation of structured simple values (like swissprot''is GN line)
 125 my $ann = Bio::Annotation::StructuredValue->new();
 126 isa_ok($ann, "Bio::AnnotationI");
 127
 128 $ann->add_value([-1], "val1");
 129 is ($ann->value(), "val1");
 130 $ann->value("compat test");
 131 is ($ann->value(), "compat test");
 132 $ann->add_value([-1], "val2");
 133 is ($ann->value(-joins => [" AND "]), "compat test AND val2");
 134 $ann->add_value([0], "val1");
 135 is ($ann->value(-joins => [" AND "]), "val1 AND val2");
 136 $ann->add_value([-1,-1], "val3", "val4");
 137 $ann->add_value([-1,-1], "val5", "val6");
 138 $ann->add_value([-1,-1], "val7");
 139 is ($ann->value(-joins => [" AND "]), "val1 AND val2 AND (val3 AND val4) AND (val5 AND val6) AND val7");
 140 is ($ann->value(-joins => [" AND ", " OR "]), "val1 AND val2 AND (val3 OR val4) AND (val5 OR val6) AND val7");
 141
 142 $n = 1;
 143 foreach ($ann->get_all_values()) {
 144     is ($_, "val".$n++);
 145 }
 146
 147 # nested collections
 148 my $nested_ac = Bio::Annotation::Collection->new();
 149 $nested_ac->add_Annotation('nested', $ac);
 150
 151 is (scalar($nested_ac->get_Annotations()), 1);
 152 ($ac) = $nested_ac->get_Annotations();
 153 isa_ok($ac, "Bio::AnnotationCollectionI");
 154 is (scalar($nested_ac->get_all_Annotations()), 6);
 155 $nested_ac->add_Annotation('gene names', $ann);
 156 is (scalar($nested_ac->get_Annotations()), 2);
 157 is (scalar($nested_ac->get_all_Annotations()), 7);
 158 is (scalar($nested_ac->get_Annotations('dblink')), 0);
 159 my @anns = $nested_ac->get_Annotations('gene names');
 160 isa_ok($anns[0], "Bio::Annotation::StructuredValue");
 161 @anns = map { $_->get_Annotations('dblink');
 162           } $nested_ac->get_Annotations('nested');
 163 is (scalar(@anns), 3);
 164 is (scalar($nested_ac->flatten_Annotations()), 2);
 165 is (scalar($nested_ac->get_Annotations()), 7);
 166 is (scalar($nested_ac->get_all_Annotations()), 7);
 167
 168 SKIP: {
 169         eval {require Graph::Directed;
 170           require Bio::Annotation::OntologyTerm; };
 171         skip('Graph::Directed not installed cannot test'.
 172                  ' Bio::Annotation::OntologyTerm module',6) if $@;
 173         # OntologyTerm annotation
 174     my $termann = Bio::Annotation::OntologyTerm->new(-label => 'test case',
 175                                                      -identifier => 'Ann:00001',
 176                                                      -ontology => 'dumpster');
 177     isa_ok($termann->term,'Bio::Ontology::Term');
 178     is ($termann->term->name, 'test case');
 179     is ($termann->term->identifier, 'Ann:00001');
 180     is ($termann->tagname, 'dumpster');
 181     is ($termann->ontology->name, 'dumpster');
 182     is ($termann->as_text, "dumpster|test case|");
 183 }
 184
 185 # AnnotatableI
 186 my $seq = Bio::Seq->new();
 187 isa_ok($seq,"Bio::AnnotatableI");
 188 my $fea = Bio::SeqFeature::Generic->new();
 189 isa_ok($fea, "Bio::AnnotatableI");
 190 my $clu = Bio::Cluster::UniGene->new();
 191 isa_ok($clu, "Bio::AnnotatableI");
 192 my $aln = Bio::SimpleAlign->new();
 193 isa_ok($clu,"Bio::AnnotatableI");
 194
 195 # tests for Bio::Annotation::AnnotationFactory
 196
 197 my $factory = Bio::Annotation::AnnotationFactory->new;
 198 isa_ok($factory, 'Bio::Factory::ObjectFactoryI');
 199
 200 # defaults to SimpleValue
 201 $ann = $factory->create_object(-value => 'peroxisome',
 202                                   -tagname => 'cellular component');
 203 like(ref $ann, qr(Bio::Annotation::SimpleValue));
 204
 205 $factory->type('Bio::Annotation::OntologyTerm');
 206
 207 $ann = $factory->create_object(-name => 'peroxisome',
 208                                -tagname => 'cellular component');
 209 ok(defined $ann);
 210 like(ref($ann), qr(Bio::Annotation::OntologyTerm));
 211
 212 SKIP: {
 213         skip("TODO: Create Annotation::Comment based on parameter only",2);
 214         ok $ann = $factory->create_object(-text => 'this is a comment');
 215         like(ref $ann, qr(Bio::Annotation::Comment));
 216 }
 217
 218 ok $factory->type('Bio::Annotation::Comment');
 219 ok $ann = $factory->create_object(-text => 'this is a comment');
 220 like(ref $ann, qr(Bio::Annotation::Comment));
 221
 222
 223 # factory guessing the type: Comment
 224 $factory = new Bio::Annotation::AnnotationFactory();
 225 ok $ann = $factory->create_object(-text => 'this is a comment');
 226 like(ref $ann, qr(Bio::Annotation::Comment));
 227
 228 # factory guessing the type: Target
 229 $factory = new Bio::Annotation::AnnotationFactory();
 230 ok $ann = $factory->create_object(-target_id => 'F1234', -start => 1, -end => 10);
 231 like(ref $ann, qr(Bio::Annotation::Target));
 232
 233 # factory guessing the type: OntologyTerm
 234 $factory = new Bio::Annotation::AnnotationFactory();
 235 ok(defined ($ann = $factory->create_object(-name => 'peroxisome',
 236                                           -tagname => 'cellular component')));
 237 like(ref $ann, qr(Bio::Annotation::OntologyTerm));
 238
 239 # tree
 240 my $tree_filename = Bio::Root::IO->catfile("t","data","longnames.dnd");
 241 my $tree=Bio::TreeIO->new(-file=>$tree_filename)->next_tree();
 242 my $ann_tree = Bio::Annotation::Tree->new(
 243                                           -tagname => 'tree',
 244                                           -tree_obj   => $tree,
 245                                          );
 246
 247 isa_ok($ann_tree, 'Bio::AnnotationI');
 248 $ann_tree->tree_id('test');
 249 is $ann_tree->tree_id(), 'test', "tree_id()";
 250 $ann_tree->tagname('tree');
 251 is $ann_tree->tagname(), 'tree', "tagname()";
 252 my $aln_filename = Bio::Root::IO->catfile("t","data","longnames.aln");
 253 use Bio::AlignIO;
 254 $aln = Bio::AlignIO->new(-file=>$aln_filename, -format=>'clustalw')->next_aln();
 255 isa_ok($aln, 'Bio::AnnotatableI');
 256 $ac = Bio::Annotation::Collection->new();
 257 $ac->add_Annotation('tree',$ann_tree);
 258 $aln->annotation($ac);
 259 foreach my $treeblock ( $aln->annotation->get_Annotations('tree') ) {
 260     my $treeref=$treeblock->tree();
 261     my @nodes = sort { defined $a->id &&
 262                       defined $b->id &&
 263                         $a->id cmp $b->id } $treeref->get_nodes();
 264     is $nodes[12]->id, '183.m01790', "add tree to AlignI";
 265     my $str;
 266     foreach my $seq ($aln->each_seq_with_id($nodes[12]->id)) { $str=$seq->subseq(1,20)}
 267     is $str, "MDDKELEIPVEHSTAFGQLV", "get seq from node id";
 268 }
 269
 270