R语言 SimHap包 haplo.surv()函数中文帮助文档(中英文对照)

loveR

haplo.surv(SimHap)
haplo.surv()所属R语言包：SimHap

                                        Haplotype analysis for survival data
                                         单倍型分析生存数据

                                         译者：生物统计家园网 机器人LoveR

描述----------Description----------

haplo.surv performs a series of Cox proportional hazards models to survival data with haplotypes using a simulation-based approach to account for uncertainty in haplotype assignment when phase is unknown.
haplo.surv进行了一系列的Cox比例风险模型的生存数据与使用基于模拟的方法来解释阶段是未知的单倍型分配的不确定性时的单倍型。


用法----------Usage----------


haplo.surv(formula1, formula2, pheno, haplo, sim, effect = "add",
        sub = NULL)



参数----------Arguments----------

参数：formula1
a symbolic description of the full model to be fit, including haplotype parameters. The response must be a survival object as returned by the Surv function.
一个象征性的描述，完整的模型是合适的，包括单倍型参数。响应必须是生存的对象返回的Surv功能。


参数：formula2
a symbolic description of the nested model excluding haplotype parameters, to be compared to formula1 in a likelihood ratio test. The response must be a survival object as returned by the Surv function.
一个象征性的嵌套模式，不包括单倍型参数的说明，相比formula1似然比检验。响应必须是生存的对象返回的Surv功能。


参数：pheno
a dataframe containing phenotype data.
一个数据框的表型数据。


参数：haplo
a haplotype object made by make.haplo.rare.
单倍型对象由make.haplo.rare。


参数：sim
the number of simulations from which to evaluate the results.
的数量的模拟来对结果进行评估。


参数：effect
the genetic effect type: "add" for additive, "dom" for dominant and "rec" for recessive. Defaults to additive. See note.
的遗传效应类型："add"添加剂"dom"主导和"rec"为隐性。默认至添加剂。见注。


参数：sub
optional. An expression using a binary operator, representing a subset of individuals on which to perform analysis. e.g. sub=expression(sex==1).
可选的。表达式中使用一个二元操作符，代表个人的一个子集进行分析。例如sub=expression(sex==1)。


Details

详细信息----------Details----------

formula1 should be in the form of response ~ predictor(s) + haplotype(s) and formula2 should be in the form response ~ predictor(s). A formula has an implied intercept term. See documentation for the formula function for more details of allowed formulae.
formula1应该是的形式response ~ predictor(s) + haplotype(s)和formula2应在的形式response ~ predictor(s)。公式有一个隐含的截距项。允许的公式的详细信息，请参阅文档formula功能。


值----------Value----------

haplo.surv returns an object of 'class' hapSurv.
haplo.surv返回一个对象的“类”hapSurv。

The summary function can be used to obtain and print a summary of the results.  
summary函数可以用来获取和打印结果的摘要。

An object of class hapSurv is a list containing the following components:
一个对象的类hapSurv的是一个列表，其中包含以下组件：


参数：formula1
formula1 passed to haplo.surv.
formula1传递给haplo.surv。


参数：formula2
formula2 passed to haplo.surv.
formula2传递给haplo.surv。


参数：results
a table containing the hazard ratios, confidence intervals and p-values of the parameter estimates, averaged over the n=sim models performed.
一个表，其中包含的风险比，置信区间和参数估计的p值，平均在n = sim模型进行。


参数：empiricalResults
a list containing the hazard ratios, confidence intervals and p-values calculated at each simulation
一个列表，其中包含的风险比，置信区间和p值在每个模拟计算


参数：logLik
the average log-likelihood for the n=sim linear models fit using formula1.
平均对数似然为n =sim线性模型适合使用公式。


参数：LRT
a likelihood ratio test, testing for significant improvement of the model when haplotypic parameters are included
似然比检验，显着改善的模型进行测试时，单倍型参数


参数：predicted
estimated marginal means of the outcome variable broken down by haplotype levels, evaluated at mean values of the model predictors, averaged over all simulations.
估计边际均值的结果变量分解评价模型的预测平均值，单倍型的水平，平均在所有的模拟。


参数：ANOVA
analysis of variance, comparing the two models fit with and without haplotypic parameters.
方差分析，比较这两个模型并没有合适的单倍型参数。


参数：Wald
The Wald test for overall significance of the fitted model including haplotypes.
Wald检验整体意义的拟合模型，包括单倍型。


参数：rsquared
r-squared values for models fit using formula1 and formula2.
模型的R平方值适合使用formula1和formula2。


参数：effect
the haplotypic effect modelled, "ADDITIVE", "DOMINANT" or "RECESSIVE".
单倍型效果为蓝本，“添加剂”，“显性”或“隐性”。


注意----------Note----------

To model a codominant haplotypic effect, define the desired haplotype as a factor in the formula1 argument. e.g. factor(h.AAA), and use the default option for effect.
要对一个显性单倍型的效果，定义所需的单倍型的一个因素formula1参数。例如factor(h.AAA)，并使用默认选项为effect。


（作者）----------Author(s)----------


Pamela A. McCaskie



参考文献----------References----------







参见----------See Also----------

snp.surv, haplo.bin, haplo.quant, haplo.long
snp.surv，haplo.bin，haplo.quant，haplo.long


实例----------Examples----------



data(SNPsurv.dat)

# convert SNP.dat to format required by infer.haplos[SNP.dat转换，格式化所需的infer.haplos]
survHaplo.dat <- SNP2Haplo(SNPsurv.dat)

data(survPheno.dat)

# generate haplotype frequencies and haplotype design matrix[产生单倍型频率和单倍型设计矩阵]
myinfer<-infer.haplos(survHaplo.dat)

# print haplotype frequencies generated by infer.haplos[打印单倍型频率所产生的infer.haplos]
myinfer$hap.freq

# generate haplo object where haplotypes with a frequency [单倍型的频率产生单倍体对象]
# below min.freq are grouped as a category called "rare"[下面min.freq分为一类被称为“罕见”]
myhaplo<-make.haplo.rare(myinfer,min.freq=0.05)

mymodel <- haplo.surv(formula1=Surv(time, status)~age+h.V1AA,
        formula2=Surv(time, status)~age, haplo=myhaplo,
        pheno=survPheno.dat, sim=10)
summary(mymodel)

# example using a subsetting variable - looking at males only[例如，使用一个子集变量 - 只在男性]
mymodel <- haplo.surv(formula1=Surv(time, status)~age+h.V1AA,
        formula2=Surv(time, status)~age, haplo=myhaplo,
        pheno=survPheno.dat, sim=10, sub=expression(sex==1))
summary(mymodel)


转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。