- formula
Symbolic expression describing what should be
processed. See `examples' for more information.
- phe
`phe' object as described in write.phe
. If
you do not have a phe file set this to NULL (i.e when you are only
using AffectionStatus from the pedigree).
- ped
`ped' object as described in write.ped
.
- file.prefix
Prefix of the output datafile (phe & ped must match)
- pedfile
Name of the pedigree file (.ped/.pped/.cped) in PBAT-format
(extension `.ped' is optional).
- phefile
Name of the phenotype file (.phe) in PBAT-format.
The default assumes the same prefix as that in 'pedfile'. Leave
empty or set to the empty string "" if you do not have a phenotype
file (i.e. you are only using AffecitonStatus). In the case of no
phenotype file, one must be created; it will be in empty_phe.phe
,
and requires loading in the pedigree file into R.
- ...
Options in higher level functions to be passed to
'pbat.create.commandfile'.
- fbat
Selects the fbat statistic used the data analysis.
"gee"
= The FBAT-GEE statistic simplifies to the standard
univariate FBAT-statistic. If several phenotypes are selected, all
phenotypes are tested simultaneously, using FBAT-GEE. The FBAT-GEE
statistic can handle any type of multivariate data.
"pc"
= FBAT extension for longitudinal phenotypes and repeated
measurements.
"logrank"
= FBAT-extensions of the classical LOGRANK and WILCOXON
tests for time-on-onset data. Kaplan-Meier plots for the
analyzed data set will be generated and plotted.
- max.pheno
(G,P) The maximum number of phenotypes that will be
analyzed in the FBAT-statistic.
- min.pheno
(G,P) The minimum number of phenotypes that will be
analyzed in the FBAT-statistic.
- null
Specification of the null-hypothesis.
"no linkage, no association"
= Null-hypothesis of no linkage and no
association.
"linkage, no association"
= Null-hypothesis of linkage, but no
association.
- alpha
Specification of the significance level.
- trans.pheno
Transformation of the selected phenotypes.
"none"
= no transformation
"ranks"
= transformation to ranks
"normal score"
= transformation to normal score
The default choice is "none"
, although it recommended to use
transformation to normal scores for quantitative phenotypes.
- trans.pred
Transformation of the selected predictor
variables/covariates:
"none"
= no transformation
"ranks"
= transformation to ranks
"normal score"
= transformation to normal score
The default choice is "none"
, although it recommended to use
transformation to normal scores for quantitative covariates.
- trans.inter
Transformation of the selected interaction variables
"none"
= no transformation
"ranks"
= transformation to ranks
"normal score"
= transformation to normal score
The default choice is "none"
, although it recommended to use
transformation to normal scores for quantitative interaction
variables.
- scan.pred
(G,P) Computation of all covariate sub-models:
"all"
= The selected FBAT statistic is computed with
adjustment for all selected covariates/predictors.
"subsets"
= The selected FBAT statistic is computed for all
possible subsets of the selected covariates/predictor variables. The
command is particularly useful to examine the dependence of
significant results on the selection of a covariate model.
- scan.inter
(G,P) Computation of all interaction sub-models:
"all"
= The selected FBAT statistic is computed including all
selected interaction variables.
"subsets"
= The selected FBAT statistic is computed for all
posible subsets of the interaction variables.
- scan.genetic
Specification of the mode of inheritance:
"additive"
= Additive model
"dominant"
= Dominant model
"recessive"
= Recessive model
"heterozygous advantage"
= Heterozygous advantage model
"all"
= The FBAT-statistics are computed for all 4 genetic models
- offset
Specification of the covariate/predictor variables
adjustment:
"none"
= No adjustments for covariates/predictor
variables. You need to select this for dichotomous traits.
"max power"
= Offset (=FBAT adjustment for
covariates and interaction variables) that maximizes
the power of the FBAT-statistic (computationally slow,
efficiency dependent on the correct choice of
the mode of inheritance)
"gee + marker score"
= Offset (=FBAT adjustment for
covariates and interaction variables) based on standard
phenotypic residuals obtained by GEE-estimation including
the expected marker score (E(X|H0)), all
covariates and interaction variables.
"gee"
= Offset (=FBAT adjustment for covariates
and interaction variables) based on standard phenotypic
residuals obtained by GEE-estimation including all
covariates and interaction variables. (default - most
of the time, with the exception of selecting from
the gui interface (not the command line) AffectionStatus)
(numeric value)
= This only works for AffectionStatus;
set a numeric value (i.e. `0.13' without the `' marks) to this.
- screening
Specification of the screening methods to handle the multiple
comparison problem for multiple SNPs/haplotypes and a set of
phenotypes.
"conditional power"
= Screening based on conditional power
(parametric approach)
"wald"
= Screening based on Wald-tests (non-parametric approach)
- distribution
Screening specification of the empirical phenotypic distribution
"default"
"jiang"
= Approach by Jiang et al (2006)
"murphy"
= Approach by Murphy et al (2006)
"naive"
= Naive allele freq estimator
"observed"
= Observed allele frequencies
- logfile
Specification of the log-file. By default, PBAT
selects an unique file-name for the log-file, i.e. "pbatlog...".
- max.gee
(G) Specification of the maximal number of iterations
in the GEE-estimation procedure.
- max.ped
Specification of the maximal number of proband in one
extended pedigrees.
- min.info
Specification of the minimum number of informative
families required for the computation of the FBAT-statistics.
- incl.ambhaplos
This command defines the handling of ambiguous
haplotypes in the haplotypes analysis. Choices:
TRUE
= Ambiguous haplotypes (phase can not be inferred) are included
in the analysis and are weighted according to their estimated
frequencies in the probands.
FALSE
= Ambiguous haplotypes are excluded from the analysis.
- infer.mis.snp
Handling of missing genotype information in the
haplotypes analysis.
FALSE
= Individuals with missing genotype information are
excluded from the analysis. This is the analysis also implemented in
the HBAT option of the FBAT-program.
TRUE
= Individuals with missing genotype information are
included in the analysis. The algorithm of Horvath et al (2004) is
applied to all individuals, even if they have missing genotype
information. This results in more ambiguous haplotypes.
- sub.haplos
FALSE
= The haplotypes defined by the all SNPs given in the
haplotype-block definition are analyzed.
TRUE
= All haplotypes are analyzed that are defined by any subset of
SNPs in the haplotypes block definition.
- length.haplos
Defines the haplotype length when subhaplos=TRUE
.
- adj.snps
Takes effect when subhaplos=TRUE
.
FALSE
= All sub-haplotypes are analyzed
TRUE
= Only the sub-haplotypes are analyzed for which the first
constituting SNPs are adjacent.
- overall.haplo
Specification of an overall haplotypes test. When
this command is included in the batch-file, only one level of the
"groups"
variable can be specified.
FALSE
= no overall test
TRUE
= an overall test is computed testing all haplotypes defined by
the same set of SNPs simultaneously. This option can not be applied
when sub.haplos=TRUE
.
- cutoff.haplo
The minimum haplotypes frequency so that a
haplotypes is included in the overall test.
- output
"normal"
= Normal PBAT output.
"short"
= Shorter output. This is mostly for use in
conjunction with 'gwa', where there is a lot of output.
"detailed"
= Detailed output for each family is created.
- max.mating.types
Maximal number of mating types in the haplotype
analysis.
- commandfile
Name of the temporary command file that will
be created to send to the pbat. It is suggested to leave
this blank, and an appropriate name will be chosen with a time
stamp.
- future.expansion
(Only included for future expansion of pbat.)
A vector of strings for extra lines to write to the batchfile for
pbat.
- logrank.outfile
(L) Name of the file to store the R source code to
generate the plots for logrank analysis.
- snps
Vector of strings for the SNPs to process. Default
processes all of the SNPs.
- phenos
(G,P) Vector of strings for the phenotypes/traits for the
analysis. If none are specified, then all are analyzed. (Note:
this must be left empty for logrank analysis, instead specify
the time to onset with the time variable.
- time
(L-R) Time to onset variable. `phenos' cannot be specified
when this is used, but it must be set for logrank.
- preds
Vector of strings for the covariates for the test
statistic.
- preds.order
Vector of integers indicating the order of 'preds'
- the order for the vector of covariates for the test
statistic.
- inters
Vector of strings for the interaction variables.
- groups.var
String for the grouping variable.
- groups
Vector of strings corresponding to the groups of the
grouping variable (groupsVar).
- censor
(L-R) String of the censoring variables. In the
corresponding data, this variable has to be binary.
- haplos
List of string vectors representing the haplotype
blocks for the haplotype analysis.
For example,
list(block1=c("m1","m2"), block2=c("m3","m4"))
defines 2 haplotype-blocks where the first block
is defined by SNPs m1 and m2, and the second by SNPs
m3 and m4.
- LOGFILE.OVERRIDE
When using the 'sym' option in read.ped and
read.phe, when this is set to TRUE (default), the PBAT logfile is
put in the current working directory; if FALSE, then it is put in
the same directory as the datafile.
- LOAD.OUTPUT
When TRUE, loads the output into R (generally
recommended). When FALSE, it leaves it in the output left from PBAT
(in case output is too large to load into memory).
- monte
When this is nonzero, monte-carlo based methods are used
to compute the p-values instead, according to the number of
iterations supplied. 1000 iterations is suggested.
- mminsnps
Multi-marker multi-phenotype tests: the minimum number
of snps to be tested.
- mmaxsnps
Multi-marker multi-phenotype tests: the maximum number
of snps to be tested.
- mminphenos
Multi-marker multi-phenotype tests: the minimum number
of phenotypes to be tested.
- mmaxphenos
Multi-marker multi-phenotype tests: the maximum number
of phenotypes to be tested.
- env.cor.adjust
Whether to adjust for environmental
correlation.
- gwa
Whether to use (g)enome (w)ide (a)cceleration mode. This
is faster for genome-wide association tests, and has slightly less
output.
- snppedfile
Whether the pedigree file contains just snps. When
this is true, it employs a more optimal storage technique and uses
much less memory. It is especially advantageous for genome-wide
studies.
- extended.pedigree.snp.fix
Set to TRUE when you are using a
dataset with large extended pedigrees. This will not work with any
mode but `single' mode currently [see pbat.set(...)].
This is also sometimes necessary for multi-allelic markers (i.e. not
binary markers).
- new.ped.algo
Set to TRUE (default is FALSE) to use the new, 10-100 times faster and more memory efficient algorithm. Somewhat experimental with extended pedigrees, so use with caution.
- cnv.intensity
The CNV intensity number that should be analyzed.
- cnv.intensity.num
The number of CNV intensities per CNV in the .cped file.