Genetics

 view release on metacpan or  search on metacpan

doc/StudyVariable.html  view on Meta::CPAN

</HEAD>

<BODY>

<A NAME="__index__"></A>
<!-- INDEX BEGIN -->

<UL>

	<LI><A HREF="#name">NAME</A></LI>
	<LI><A HREF="#synopsis">SYNOPSIS</A></LI>
	<LI><A HREF="#description">DESCRIPTION</A></LI>
	<LI><A HREF="#license">LICENSE</A></LI>
	<LI><A HREF="#feedback">FEEDBACK</A></LI>
	<LI><A HREF="#author  steve mathias">AUTHOR - Steve Mathias</A></LI>
	<LI><A HREF="#details">DETAILS</A></LI>
	<LI><A HREF="#imported packages">Imported Packages</A></LI>
	<LI><A HREF="#public methods">Public methods</A></LI>
	<UL>

		<LI><A HREF="#printxml">printXML</A></LI>
		<LI><A HREF="#ashtml">asHTML</A></LI>
	</UL>

</UL>
<!-- INDEX END -->

<HR>
<P>
<H1><A NAME="name">NAME</A></H1>
<P>Genetics::StudyVariable</P>
<P>
<HR>
<H1><A NAME="synopsis">SYNOPSIS</A></H1>
<PRE>
  $sv = new Genetics::StudyVariable(name =&gt; 'EA Aff Stat',
                                    importID =&gt; 445,
                                    dateCreated =&gt; $today,
                                    Keywords =&gt; [ {name =&gt; &quot;Test Data&quot;, 
                                                   dataType =&gt; &quot;Boolean&quot;, 
                                                   value =&gt; 1}, 
                                                ], 
                                    description =&gt; &quot;EA Trait Locus&quot;, 
                                    category =&gt; &quot;AffectionStatus&quot;, 
                                    format =&gt; &quot;Code&quot;, 
                                    isXLinked =&gt; 0, 
                                    Codes =&gt; [ {code =&gt; 0,
                                                description =&gt; &quot;Unknown EA Status&quot;},
                                               {code =&gt; 1,
                                                description =&gt; &quot;EA Unaffected&quot;},
                                               {code =&gt; 2,
                                                description =&gt; &quot;EA Affected&quot;},
                                             ], 
                                    AffStatDef =&gt; {name =&gt; 'EA',
                                                   diseaseAlleleFreq =&gt; 0.001,
                                                   pen11 =&gt; 0.0,
                                                   pen12 =&gt; 0.0,
                                                   pen22 =&gt; 1.0,
                                                   AffStatElements =&gt; [ {code =&gt; 0,
                                                                         type =&gt; &quot;Unknown&quot;,
                                                                         formula =&gt; &quot;'EA Aff Stat' = 0&quot;}, 
                                                                        {code =&gt; 1,
                                                                         type =&gt; &quot;Unaffected&quot;,
                                                                         formula =&gt; &quot;'EA Aff Stat' = 1&quot;}, 
                                                                        {code =&gt; 2,
                                                                         type =&gt; &quot;Affected&quot;,
                                                                         formula =&gt; &quot;'EA Aff Stat' = 2&quot;}, 
                                                                      ],
                                                  },
                                    LCDef =&gt; {name =&gt; 'EA Default LC',
                                              LiabilityClasses =&gt; [ {code =&gt; 0,
                                                                     description =&gt; &quot;Unknown Age&quot;,
                                                                     pen11 =&gt; 0.0,
                                                                     pen12 =&gt; 0.0,
                                                                     pen22 =&gt; 1.0,
                                                                     formula =&gt; &quot;'Age' = ''&quot;}, 
                                                                    {code =&gt; 1,
                                                                     description =&gt; &quot;Age less than 40&quot;,
                                                                     pen11 =&gt; 0.0,
                                                                     pen12 =&gt; 0.2,
                                                                     pen22 =&gt; 1.0,
                                                                     formula =&gt; &quot;'Age' &lt; 40&quot;}, 
                                                                    {code =&gt; 2,
                                                                     description =&gt; &quot;Age less than 50&quot;,
                                                                     pen11 =&gt; 0.0,
                                                                     pen12 =&gt; 0.3,
                                                                     pen22 =&gt; 1.0,
                                                                     formula =&gt; &quot;'Age' &lt; 50&quot;}, 
                                                                    {code =&gt; 3,
                                                                     description =&gt; &quot;Age grater than or equal to 60&quot;,
                                                                     pen11 =&gt; 0.0,
                                                                     pen12 =&gt; 0.4,
                                                                     pen22 =&gt; 1.0,
                                                                     formula =&gt; &quot;'Age' &gt;= 60&quot;}, 
                                                                  ],
                                             },
                                   ) ;
</PRE>
<PRE>

See the GenPerl Tutorial for more information.</PRE>
<P>
<HR>
<H1><A NAME="description">DESCRIPTION</A></H1>
<P>StudyVariable objects represent definitions of physical traits, affection 
status loci, environmental exposure, or drug treatments.</P>
<P>
<HR>
<H1><A NAME="license">LICENSE</A></H1>
<P>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.</P>
<P>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.</P>
<P>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</P>
<P>
<HR>
<H1><A NAME="feedback">FEEDBACK</A></H1>
<P>Currently, all feedback should be sent directly to the author.</P>
<P>
<HR>
<H1><A NAME="author  steve mathias">AUTHOR - Steve Mathias</A></H1>
<P>Email: <A HREF="mailto:mathias@genomica.com">mathias@genomica.com</A></P>
<P>Phone: (720) 565-4029</P>
<P>Address: Genomica Corporation 
         1745 38th Street
         Boulder, CO 80301</P>
<P>
<HR>
<H1><A NAME="details">DETAILS</A></H1>
<P>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 (_).</P>
<P>
<HR>
<H1><A NAME="imported packages">Imported Packages</A></H1>
<PRE>
 Genetics::Object       Superclass
 strict                 Just to be anal
 vars                   Global variables</PRE>
<P>
<HR>
<H1><A NAME="public methods">Public methods</A></H1>
<PRE>
  printXML              Print an XML representation of the object</PRE>
<P>
<H2><A NAME="printxml">printXML</A></H2>
<PRE>
  Function  : Print an XML representation of the object.



( run in 0.592 second using v1.01-cache-2.11-cpan-39bf76dae61 )