Bio::EnsEMBL::Map::MapLocation Class Reference

Public Member Functions
public Bio::EnsEMBL::Map::MapLocation	new ()
public String	map_name ()
public String	name ()
public String	chromosome_name ()
public String	position ()
public Float	lod_score ()

Detailed Description

Synopsis

Description

Represents a location on a genetic map, yac map, radition hybrid map,
etc.

Definition at line 14 of file MapLocation.pm.

Member Function Documentation

chromosome_name()

public String Bio::EnsEMBL::Map::MapLocation::chromosome_name

(

)

  Arg [1]    : (optional) string $chromosome_name
  Example    :

$chr_name = $map_location->chromosome_name;
              $map_location->chromosome_name('X');

  Description: The name of the chromosome associated with this map location
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : stable

Code:

lod_score()

public Float Bio::EnsEMBL::Map::MapLocation::lod_score

(

)

  Arg [1]    : (optional) float $lod
  Example    :

$lod = $map_location->lod_score;

  Description: Getter/Setter for lod score of this map location
  Returntype : float
  Exceptions : none
  Caller     : general
  Status     : stable

Code:

map_name()

public String Bio::EnsEMBL::Map::MapLocation::map_name

(

)

  Arg [1]    : string $map_name
  Example    :

$map_name = $map_location->map_name;

  Description: Getter/Setter for the map name
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : stable

Code:

name()

public String Bio::EnsEMBL::Map::MapLocation::name

(

)

  Arg [1]    : (optional) string $name
  Example    :

$name = $map_location->name;

  Description: A name associated with the marker at this position.  For
               example if this is a genethon map location the name will be
               the synonym of source genethon.
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : stable

Code:

new()

public Bio::EnsEMBL::Map::MapLocation Bio::EnsEMBL::Map::MapLocation::new

(

)

  Arg [1]    : (optional) string $name
  Arg [2]    : (optional) string $map_name
  Arg [3]    : (optional) string $chromosome_name
  Arg [4]    : (optional) string $position
  Arg [5]    : (optional) float $lod_score
  Example    :

$map_location = Bio::EnsEMBL::Map::MapLocation->
                new('DS1234',
                    'genethon',
                    'X',
                    '12.39',
                    50.12);

  Description: Creates a new MapLocation
  Returntype : Bio::EnsEMBL::Map::MapLocation
  Exceptions : none
  Caller     : general
  Status     : stable

Code:

position()

public String Bio::EnsEMBL::Map::MapLocation::position

(

)

  Arg [1]    : (optional) string $position
  Example    :

$pos = $map_location->position;

  Description: Getter/Setter for the position of this map location
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : stable

Code:

---

The documentation for this class was generated from the following file:

• ensembl/modules/Bio/EnsEMBL/Map/MapLocation.pm