#$Author: sinnwell $
#$Date: 2004/11/23 20:15:44 $
#$Header: /people/biostat3/sinnwell/Projects/arp/Make/RCS/README.arp.gee,v 1.1 2004/11/23 20:15:44 sinnwell Exp $
#$Locker:  $
#$Log: README.arp.gee,v $
#Revision 1.1  2004/11/23 20:15:44  sinnwell
#Initial revision
#

Brief Description:
Description: Simultaneously estimate trait-locus position and its
genetic effect for affected relative pairs using two different
estimation assumptions.  Either allow a different trait-locus effect
for each ARP type, or model as a single susceptibility locus. Includes
testing procedures for comparison of the two assumptions.

A further description can be found in README within the S-PLUS
package, or the contents of README may be viewed in S-PLUS entering
the command:

	 library(lib.loc="/INSTALLATION DIR PATH/", help=arp.gee)

The same information is available in the R package within the files
named INDEX.arp.gee and DESCRIPTION.arp.gee.


=================================================================

Installation procedures for arp.gee 

We develop the arp.gee library for use in both Splus and R on a
unix system.  Intallation procedures in this file are for setting up a
'local library' for a user. If a large group of users plan to use the
same library, then install on a system-wide 'library' location
designated by a system administrator.

--------------------------------------------------------------

S-PLUS Installation

The arp.gee Splus functions are written for Splus version 6.1. 

To install the software for local use in Splus, move arp.gee_x.y.z_S.tar.gz to
your installation directory and follow the series of commands:

1) gunzip arp.gee_x.y.z_S.tar.gz
2) tar -xvf arp.gee_x.y.z_S.tar
3) cd arp.gee
4) cd src
5) Splus CHAPTER -m
6) Splus make -f makefile.arp.gee

NOTE: It is important to use the '-m' option for CHAPTER, to prevent
over-writing the supplied makefile.

--------------------------------------------------------------

R Installation

For local installation, execute the following command with the local
"INSTALL LIBRARY DIR PATH" correctly specified.

R CMD INSTALL -l /INSTALL LIBRARY DIR PATH/ arp.gee_x.y.z.tar.gz

Installation instructions for different use may be found on the R project
website (http://www.r-project.org).


======================================================================

User Documenation:

A user manual is provided in the arp.gee/doc/ directory. Information
on the supplied functions can be found within both the Splus and R
systems by typing help(function), where 'function' is the name of the
procedure of interest (no quotes needed). The code used in the user
manual is located within the arp.gee/demo/ directory. This code can be
used to test the various functions to check the computed output
against the manual.  Follow additional instructions in the manual.