Updating twinData.Rd to document the reuse of zyg 6:10. Also added Nick Martin reference
[openmx:openmx.git] / man / twinData.Rd
1 %
2 %   Copyright 2007-2013 The OpenMx Project
3 %
4 %   Licensed under the Apache License, Version 2.0 (the "License");
5 %   you may not use this file except in compliance with the License.
6 %   You may obtain a copy of the License at
7
8 %        http://www.apache.org/licenses/LICENSE-2.0
9
10 %   Unless required by applicable law or agreed to in writing, software
11 %   distributed under the License is distributed on an "AS IS" BASIS,
12 %   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 %   See the License for the specific language governing permissions and
14 %   limitations under the License.
15
16 \name{twinData}
17 \alias{twinData}
18 \title{Australian twin sample biometric data.}
19 \description{
20 Australian data on body mass index (BMI) assessed in both MZ and DZ twins, and saved in the text file twinData.txt. 
21
22 Questionnaires were mailed to 5967 pairs age 18 years and over. These data consist of completed questionnaires returned by both members of 3808 (64 percent) pairs. There are two cohort blocks in the data: a younger group (zyg 1:5), and an older group (zyg 6:10)
23  
24 It is a wide dataset, with two individuals per line. Data include zygosity (zyg), along with heights in metres, weights in kg, and the derived variables BMI in kg/m^2 (stored as "htwt1" and "htwt2"), as well as the log of this variable, stored here as bm1 and bm2. The logged values are more closely normally distributed.
25
26 fam is a family identifier. Age is entered only once, as the both twins in each pair share a common age.
27
28 }
29
30 \references{
31 Martin, N. G. & Jardine, R. (1986). Eysenck's contribution to behavior genetics. In S. Modgil & C. Modgil (Eds.), Hans Eysenck: Consensus and Controversy. Falmer Press: Lewes, Sussex.
32
33 Martin, N. G., Eaves, L. J., Heath, A. C., Jardine, R., Feindgold, L. M., & Eysenck, H. J. (1986). Transmission of social attitudes. Proceedings of the National Academy of Science, 83, 4364-4368.
34 }
35
36 \usage{data(twinData)}
37 \format{
38  A data frame with 3808 observations on the following 12 variables.
39  \describe{
40  \item{\code{fam}}{a numeric vector} of family IDs
41  \item{\code{age}}{a numeric vector} of ages (years)
42  \item{\code{zyg}}{a numeric vector} of zygosity (see below for important details)
43  \item{\code{part}}{a numeric vector}
44  \item{\code{wt1}}{a numeric vector} of weights in kg (twin 1)
45  \item{\code{wt2}}{a numeric vector} of weights in kg (twin 2)
46  \item{\code{ht1}}{a numeric vector} of heights in kg (twin 1)
47  \item{\code{ht2}}{a numeric vector} of heights in kg (twin 2)
48  \item{\code{htwt1}}{a numeric vector} of kg/m^2 twin 1
49  \item{\code{htwt2}}{a numeric vector} of kg/m^2 twin 2
50  \item{\code{bmi1}}{a numeric vector} of log BMI for twin 1
51  \item{\code{bmi2}}{a numeric vector} of log BMI for twin 2
52  }
53 }
54 \details{
55 Zygosity is coded as follows
56 1 == MZFF (i.e MZ females)
57 2 == MZMM (i.e MZ males)
58 3 == DZFF
59 4 == DZMM
60 5 == DZOS opposite sex pairs
61
62 Note: Zygosity 6:10 is the same, for an older cohort in the sample. So:
63 6 == MZFF (i.e MZ females)
64 7 == MZMM (i.e MZ males)
65 8 == DZFF
66 9 == DZMM
67 10 == DZOS opposite sex pairs
68
69 }
70 \examples{
71 data(twinData)
72 str(twinData)
73 plot(wt1 ~ wt2, data = twinData)
74 mzData <- as.matrix(subset(myTwinData, zyg == 1, c(bmi1, bmi2)))
75 dzData <- as.matrix(subset(myTwinData, zyg == 3, c(bmi1, bmi2)))
76 }
77 \keyword{datasets}