Map.pm

- NAME
- SYNOPSIS
- DESCRIPTION
- LICENSE
- FEEDBACK
- AUTHOR - Steve Mathias
- DETAILS
- Imported Packages
- Public methods

- printXML

# NAME

Genetics::Map

# SYNOPSIS

      $map = new Genetics::Map(name => 'Chr12 2 PO',
                               importID => 121,
                               dateCreated => $today,
                               comment => "Stupid 2-marker map.",
                               Keywords => [ {name => "Test Data",
                                              dataType => "Boolean",
                                              value => 1},
                                           ],
                               chromosome => "12",
                               orderingMethod => "Relative",
                               distanceUnits => "cM",
                               Organism => {genusSpecies => "Pongo pongo"},
                               OrderedMapElements => [ {SeqObj => {name => "D12S91", importID => 1},
                                                        distance => 1.3},
                                                       {SeqObj => {name => "EAEx1.1", importID => 265}}
                                                     ],
                              ) ;

    See the GenPerl Tutorial for more information.

# DESCRIPTION

Map objects represent an ordered list of Markers and the distances between them.

# LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

# FEEDBACK

Currently, all feedback should be sent directly to the author.

# AUTHOR - Steve Mathias

Email: mathias@genomica.com

Phone: (720) 565-4029

Address: Genomica Corporation 1745 38th Street Boulder, CO 80301

# DETAILS

The rest of the documentation describes each of the object variables and methods. The names of internal variables and methods are preceded with an underscore (_).

# Imported Packages

      Genetics::Object      Superclass
      strict                Just to be anal
      vars                  Global variables

# Public methods

      printXML              Write an XML representation of an object

## printXML

      Function  : Print an XML representation of the object.
      Argument  : A XML::Writer object that will be used to generate the XML.
      Returns   : String
      Scope     : Public
      Called by : Calls Genetics::Object->printGeneralXML to generate XML elements
                  common to all Genetics::Object objects.