[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
1.1 Overview of MORGAN 1.2 Get the Tutorial 1.3 Get and set up the examples 1.4 Overview of the pedigrees used in the examples 1.5 Structure of the MORGAN package
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
MORGAN (Monte Carlo Genetic Analysis) is a collection of programs and libraries developed at the University of Washington under the PANGAEA (Pedigree Analysis for Genetics and Epidemiological Attributes) umbrella. This software implements a number of methods for the analysis of data observed on members of a pedigree, with the main programs implementing Markov Chain Monte Carlo (MCMC) methods. As of the date of this tutorial, the latest MORGAN version is 3.0.3 which was released in November 2011. It is available for download through the MORGAN home page at the Department of Statistics, University of Washington.
The MORGAN programs are grouped into four categories:
pedcheck
checks for errors in
pedigree structure and data format, see Checking Pedigree Validity.
kin
computes kinship and inbreeding coefficients for members of the
pedigree, see
Computing Kinship and One- or Two-Locus Inbreeding Coefficients.
genedrop
simulates data on a
pedigree for analysis by other programs, see
Simulating Marker and Trait Data in Pedigrees. markerdrop
simulates marker data at loci linked to a trait locus, see
Simulating Marker Data Conditional on Trait Data in Pedigrees.
ibddrop
uses Monte Carlo to estimate gene ibd (identity by descent)
probabilities in the absence of data, see
Estimating a priori IBD Probabilities by Monte Carlo.
The `Autozyg' and `Lodscore' programs may be categorized in four subsets:
lm_auto
, gl_auto
and lm_pval
, estimate conditional gene
ibd probabilities; see
Estimating Conditional IBD Probabilities by MCMC.
lm_ibdtests
and civil
realize inheritance conditional on genetic marker data and
uses these realizations to estimate ibd-based
test statistics for linkage detection;
see Estimating IBD Based Test Statistics by MCMC.
lm_linkage
, lm_bayes
and lm_twoqtl
,
estimate multipoint lod scores; see
Estimating Location lod Scores by MCMC.
lm_map
realizes inheritance conditional on genetic marker data, and
uses these realizations in the estimation of genetic maps;
see Estimating Genetic Maps from Marker Data.
univar
, unibig
, bivar
and multivar
, see
Polygenic Modeling of Quantitative Traits by EM Algorithm.
This tutorial is based on the tutorial and examples for MORGAN 2.9 developed over the years 2002-2010 by Elizabeth Thompson, Michael Na Li, Myrna Jewett, Adele Mitchell, Audrey Fu, Tia Lerud, and Marshall Brown. MORGAN 2.9 and its accompanying tutorial remain available for download. Adam Gustafson updated the examples and tutorial for the new parameter statements of MORGAN 3.0 in 2011, and the text has been significantly updated and revised by Elizabeth Thompson.
Combined with hands-on examples, this tutorial gives a brief introduction to the usage of the main MORGAN programs. For further information, please refer to the MORGAN documentation and to the references cited.
See Concept Index for: MORGAN, overview of MORGAN.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Several formats of this tutorial are also available to download for off-line reading or printing. (These may not be available with the initial online release of the tutorial. The html, PDF, and plain text versions are recommended.)
See Concept Index for: how to get the tutorial.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This tutorial assumes that the MORGAN software has already been installed. If this is not the case, please contact your local system administrator or download the software yourself and follow the instructions therein.
Follow the following steps to download and set up the examples:
tar zxvf morgan-examples_V30.tar.gz |
Or if the above command fails (you don't have GNU tar), use
gunzip -c morgan-examples_V30.tar.gz | tar xvf - |
This will produce a `MORGAN_V30_Examples' directory under your current directory.
(Note: Throughout the text, file and directory names are enclosed in single quotes; these single quotes are not part of the file or directory name.)
Before making links, you first need to edit the `Makefile' (using your
favorite text editor, for instance vim
or nano
) in the
`MORGAN_V30_Examples' directory to make sure the paths to your MORGAN
programs and those to the `MORGAN_V30_Examples' directory are correct. Most
often, it is necessary to change the `MORGANDIR' and `EXAMPLEDIR'
statements to reflect the locations of the MORGAN files on your system
and the examples, respectively. Here is the relevant part of the
`Makefile',
# Change the following macros to where MORGAN and the examples # are installed on your system. This is the only change you # need to make in this file. MORGANDIR = ~/morgan/MORGAN_V302_Release EXAMPLEDIR = `pwd` BINDIR = ~/bin # Note: the paths may happen to be same for MORGANDIR and # EXAMPLEDIR. In general they are different: # MORGANDIR is where MORGAN is installed on your system # EXAMPLEDIR is the MORGAN_V30_Examples directory you have made # (we have used the BASH command `pwd` to automate this) # BINDIR is your bin directory # BINDIR is needed only if you prefer to link to executables from # your bin directory, rather than running from executables in # a current directory. |
For more information on how to use Makefile to build links, etc., you may type:
make help |
To make symbolic links to those programs in the current directory, type
make links |
Notes for Microsoft Windows users:
MORGAN may be (in principle) installed under Windows: executables should then be placed in the directory in which programs are to be run. See the documentation for more information. We cannot currently answer any questions regarding Windows installation. Instead, we recommend the use of a linux-system emulator such as Cygwin.
See Concept Index for: how to get the examples.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Except for some small pedagogical pedigrees for pedcheck
under
`Pedcheck', two main pedigree files are used to illustrate the usage of
MORGAN programs.
File `jv_rep.ped', located under `IBD', is composed of two replicates of the JV pedigree. The 15-individual 5-generation JV pedigree derives from a real study of a rare recessive trait by Goddard et. al. [GYO96].
The other pedigree in `ped73.ped', located under `MORGAN_V30_Examples', consists of three components and 73 individuals: component one has 47 individuals over 6 generations, component two 11 individualus over 3 generations, and component three 15 individuals over 3 generations. In general, individuals from later generations are observed. The three components are displayed in `ped47.pdf', `ped11.pdf' and `ped15.pdf', which are located in the subdirectory `PedInfo'.
See Concept Index for: Tutorial for lod score examples with `ped73.ped'.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
It is not necessary to read this section in order to use MORGAN, to run the examples, or to modify them for your own use. However, for those who wish to modify MORGAN code, or to understand MORGAN more fully, it will be useful to have information on the directory structure, the README documentation, and the GOLD-standard documentaion, Makefiles, and examples. These are therefore described in this section, updated for the released version of MORGAN 3.0.3.
Within the main MORGAN directory, there are program directories, and within these there the Gold-standard directories. At each level there are README files which provide additional documentation. In many cases, this information is duplicated in the tutorial, but whereas the Tutorial is focused to the user, README documentation is focused to the modifier and developer.
These include `README_readme', `README_MORGAN', `README_install', and `README_relnotes'.
In some MORGAN releases there may be additional main-directory README files.
The main program dirctories of MORGAN 3.0.3 are PedComp, Genedrop, Autozyg, Lodscore, and PolyEM. Each main program directory contains its own `README_userdoc'. This describes the inputs to be prepared for the programs, and the various program options. Most of this information is now included in the tutorial, but the README files may contain more detail in some cases.
Each of the main program directories contains a file `README_convert2_3.0' which specifies the changes one must make in order to conver parameter files from MORGAN 2.9 to 3.0.
The Library Subroutine directories do not contain README files.
Each main program directory contains a subdirectory Gold. These directories include examples that may be run to check correct installation of MORGAN, and to provide a wider array of example parameter files than are currently in the example files used in the tutorial. Each Gold subdirectory contains a `README_gold' file detailing the examples in that directory.
The subroutine library directories contain the code for the library routines. During installation of MORGAN, each creates a library file from which the required subroutines are loaded into the executable of each main program.
The header files for all libraries and programs are contained in the Headers subdirectory of MORGAN. Typically there is one or more header files associated with each library, and named accordingly. For example, the file `nghds.h' in `Headers' corresponds to the Nghds subroutine library. More complex libraries such as Pars have a large number of corresponding header files.
The libraries can be divided broadly into four groups:
In addition to the subroutine libraries, the subdirectory `Utils' of
Autozyg contains code for subroutines that are directly incorporated into the
lm_ibdtests
and lm_map
programs.
Also, the subdirectory `NewRtnes' of
Lodscore includes code directly incorporated into the lm_bayes
program.
These routines were written by the authors of those programs. They may
eventually be incorporated into the MORGAN subroutine libraries.
The main program directories of MORGAN 3.0.3 are PedComp, Genedrop, Autozyg, Lodscore, and PolyEM. When MORGAN is installed these directories contain the following executables:
More details about all of these executable programs can be found either in this tutorial or in the README_userdoc files of the relevant main program directory.
The Gold subdirectories of the main program directories PedComp, Genedrop, PolyEM, Autozyg, and Lodscore contain example runs of all the main programs in order to test various aspects of code and installation. Examples for a particular main program are in the Gold subdirectory of that main program directory.
The Gold subdirectories typically contain numerous test parameter files, pedigee
files, and marker data files. The tests are run via Makefiles, and the command
make help.gold
will provide details. Additionally, the
`README_gold' file in each directory will give details of the examples.
Examples may run using the make
command. Typically the complete set of
examples in any Gold directory is run using the command make all.gold
.
More detailed information is given by using make help.gold
or by viewing
the Makefile
. Since the Gold tests and examples are intended primarily
for developers, it is expected that viewing and modifying the Makefile examples
will pose no difficulties.
See Concept Index for: structure of the MORGAN package, README documentation files, MORGAN program libraries, MORGAN subroutine libraries, MORGAN Gold standards.
[ << ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |