Usage
multic(formula, data = sys.parent(), famid, id, dadid, momid, sex,
mloci.out = NULL, share.out = "kinship", longitudinal = FALSE,
subset = NULL, ascertainment = NULL,
control = multic.control(...), ...)Arguments
formula
a formula object, with the traits on the
left of a ~ (tilde) operator
and the covariates, separated by +
operators, on the right. The
traits may be a single numeric vector or a matrix. Commonly, traits
are aggragated together
famid
integer, numeric, or character vector specifying each individual's
family identifier. Members of the same family must have the same
famid and each family must have a unique
famid. Any missing data
will result in an error messa
id
integer, numeric, or character vector specifying each individual's
identifier. Members of the same family must have a unique
id within
the family. id does not have to be
universally unique among all
individuals. Any missing
dadid
integer, numeric, or character vector specifying each individual's
father identifier. This father identifier must have the same
famid as
the individual. Any missing data will result in an
error message and the termination of multic
momid
integer, numeric, or character vector specifying each individual's
mother identifier. This mother identifier must have the same
famid as
the individual. Any missing data will result in an
error message and the termination of
multic
sex
integer, numeric, or character vector specifying each individual's
sex. Acceptable forms of sex-coding are
"M", "m", or
1 for male and
"F", "f", or
2 for female. Any missing da
data
data.frame in which to interpret the
variables named in formula,
famid, id,
dadid,
momid,
sex,
subset, and
ascertainment arguments. If
mloci.out
a character value specifying a path to an mloci.out (or
similarly formatted) file. Specifying a non-empty mloci.out file will
allow multic to calculate sporadic models using the ibd (identity by
decent) information in the mloci.out file. Due to the gene
share.out
a character value specifying a path to a share.out (or
similarly formatted) file. This file contains the amount of
genetic material shared between each family member pair based on
family structure only. It also contains boolean values to indicate
whethe
longitudinal
logical flag: if TRUE, then fomula will
be interpreted as a
longitudinal model. In this case, the fomula argument requires
special formatting as described. The number of traits on the
left side of the ~ (tilde) is the number
o
subset
a logical vector specifying which subset of the rows in
data to
use in the fit.
ascertainment
vector specifying each individual's ascertainment (effected) status.
Acceptable forms of ascertainment are T,
TRUE, or 1
for a proband (effected) and F,
FALSE, or
0 for a non-p
control
list of iteration and algorithmic
constants. See
multic.control for their names and
default values. These can also be given directly as arguments to
multic itself, instead of through a
multic.control ob
...
further arguments passed to
multic.control to alter
multic's default behavior.