lib/Bio/GeneticRelationships/Pedigree.pm

   1 package Bio::GeneticRelationships::Pedigree;
   2 use strict;
   3 use warnings;
   4 use Moose;
   5 use MooseX::FollowPBP;
   6 use Moose::Util::TypeConstraints;
   7 use Bio::GeneticRelationships::Individual;
   8
   9 =head1 NAME
  10
  11 Bio::GeneticRelationships::Pedigree - Pedigree of an individual
  12
  13 =head1 SYNOPSIS
  14
  15 my $variable = Bio::GeneticRelationships::Pedigree->new();
  16
  17 =head1 DESCRIPTION
  18
  19 This class stores an individual's pedigree.
  20
  21 =head2 Methods
  22
  23 =over
  24
  25 =cut
  26
  27 subtype 'CrossType',
  28   as 'Str',
  29     where {
  30       $_ eq 'biparental' ||
  31       $_ eq 'self' ||
  32       $_ eq 'open' ||
  33       $_ eq 'bulk' ||
  34       $_ eq 'genetic_transformation' ||
  35       $_ eq 'unknown' };
  36
  37 has 'name' => (isa => 'Str',is => 'rw', predicate => 'has_name', required => 1,);
  38 has 'cross_type' => (isa =>'CrossType', is => 'rw', predicate => 'has_cross_type', required => 1,);
  39 has 'female_parent' => (isa =>'Bio::GeneticRelationships::Individual', is => 'rw', predicate => 'has_female_parent');
  40 has 'male_parent' => (isa =>'Bio::GeneticRelationships::Individual', is => 'rw', predicate => 'has_male_parent');
  41 has 'selection_name' => (isa => 'Str',is => 'rw', predicate => 'has_selection_name');
  42
  43
  44 ###
  45 1;                              #do not remove
  46 ###
  47
  48 =pod
  49
  50 =back
  51
  52 =head1 LICENSE
  53
  54   Same as Perl.
  55
  56 =head1 AUTHORS
  57
  58   Jeremy D. Edwards <jde22@cornell.edu>
  59
  60 =cut