R语言 SpeCond包 getFullHtmlSpeCondResult()函数中文帮助文档(中英文对照)

loveR

getFullHtmlSpeCondResult(SpeCond)
getFullHtmlSpeCondResult()所属R语言包：SpeCond

                                         Visualisation function of the SpeCond analysis results
                                         的SpeCond分析结果的可视化功能

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

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

getFullHtmlSpeCondResult generates a full result html page.
getFullHtmlSpeCondResult生成一个完整的结果HTML页面。


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


getFullHtmlSpeCondResult(SpeCondResult=NULL, L.specific.result = NULL,
param.detection = NULL, page.name = "SpeCond_result",
page.title = "Condition-specific analysis results", prefix.file = NULL,
outdir="General_Result", sort.condition = "all",
gene.page.info=NULL, heatmap.profile = TRUE, heatmap.expression = FALSE,
heatmap.unique.profile = FALSE, expressionMatrix = NULL)



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

参数：SpeCondResult
the sp_list class object result of the SpeCond functions
sp_list类SpeCond功能对象的结果


参数：L.specific.result
List of results present in the sp_list class specificResult object, see SpeCond or getSpecificResult functions
结果在目前的sp_list类specificResult对象名单，请参阅SpeCond或getSpecificResult功能


参数：param.detection
The parameter matrix used by the SpeCond detection procedure
由SpeCond检测程序使用的参数矩阵


参数：page.name
The name of the result html page. The default is "SpeCond\_result"
结果HTML页面的名称。默认是的“SpeCond \ _result”


参数：page.title
The title of the result html page. The default is "Condition-specific analysis results"
结果HTML页面的标题。默认是“特定条件的分析结果”


参数：prefix.file
a prefix added to the generated file(s) and the outdir directory name to linked them to the full result html page, by default is NULL, the prefix.file  attribute of the SpeCondResult  is used. It is useful to change the prefix when you create a new result page. As you may want to get results with different parameter sets and plots so using a different SpeCondResult or L.specific.result objects
前缀添加到生成的文件（S）和outdir目录的名称，联系他们完整的结果HTML页面，默认值为NULL，prefix.file的属性SpeCondResult“使用。它是有用的改变前缀，当你创建一个新的结果页面。正如您可能希望得到不同的参数集和图的结果，以便使用不同SpeCondResult或L.specific.result对象


参数：outdir
the name of the directory in which the generated files will be created. The default is "General_result"
将创建的目录中生成的文件的名称。默认“General_result”


参数：sort.condition
If the condition must sorted in the barplot presented the number of specific genes by condition. Can table the values: positive", "negative", "all": the conditions are sorted respectively by the number of specific genes detected as up-regulated, down-regulated or both
如果条件必须在barplot排序条件的特定基因的数量。表值：积极的“，”负翁“，”所有“的条件进行排序分别由一些特定的基因检测上调，下调或两者


参数：gene.page.info
the result of the getGeneHtmlPage function. Enables the creation of links between this full result page and the single result pages created by the previous function. The default is "NULL"; no links are created
getGeneHtmlPage函数的结果。允许建立这个完整的结果页和单一的结果，由先前的功能创建的页面之间的链接。默认的是“空”;没有链接创建


参数：heatmap.profile
TRUE/FALSE, to print or not a heatmap showing the specific profile of the genes. The default is FALSE
真/假，打印或不热图显示基因的具体轮廓。默认是FALSE


参数：heatmap.expression
TRUE/FALSE, to print or not a heatmap showing the expression of the genes. The default is FALSE
真/假，打印或不热图显示，该基因的表达。默认是FALSE


参数：heatmap.unique.profile
TRUE/FALSE, to print or not a heatmap showing the unique specific profile. The default is FALSE
真/假，打印或不热图显示出独特的具体轮廓。默认是FALSE


参数：expressionMatrix
Must not be NULL if heatmap.expression=TRUE, must be the same as the input expression matrix. The default is NULL
不能是NULL如果heatmap.expression = TRUE时，必须输入表达式的矩阵相同。默认值为NULL


Details

详情----------Details----------

Either SpeCondResult or L.specific.result can be specified to use this function. If you use L.specific.result you ahve tp define prefix.file.
要么SpeCondResult或L.specific.result可以指定要使用此功能。如果你使用L.specific.result你ahve TP定义prefix.file。


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


Florence Cavalli, florence@ebi.ac.uk



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

getGeneHtmlPage
getGeneHtmlPage


举例----------Examples----------


library(SpeCond)
data(expressionSpeCondExample)
##Perform the condition specific detection analysis with SpeCond()[＃执行的具体检测分析与SpeCond条件（）]
generalResult=SpeCond(expressionSpeCondExample, param.detection=NULL,
                        multitest.correction.method="BY", prefix.file="E", print.hist.pv=TRUE,
                        fit1=NULL, fit2=NULL, specificOutlierStep1=NULL)

specificResult=generalResult$specificResult

##Produce the general html page results[＃一般的HTML页面结果]
getFullHtmlSpeCondResult(SpeCondResult=generalResult, param.detection=       
  specificResult$param.detection, page.name="Example_SpeCond_results",
  page.title="Tissue specific results", sort.condition="all", heatmap.profile=TRUE,
  heatmap.expression=FALSE, heatmap.unique.profile=FALSE,
  expressionMatrix=expressionSpeCondExample)

##Produce the Gene html page results for the first 20 genes using the specificResult object to be able to link [＃生产第20使用specificResult对象基因的基因html页面结果，可以连接]
## these pages to the table result in the general html page[＃这些网页在一般的HTML页面表结果]
specificResult=generalResult$specificResult
genePageInfo=getGeneHtmlPage(expressionSpeCondExample, specificResult, name.index.html=
  "index_example_SpeCond_Results.html",outdir="Single_result_pages_example",
   gene.html.ids=c(1:20))

##Produce the general html page results[＃一般的HTML页面结果]
getFullHtmlSpeCondResult(L.specific.result=specificResult$L.specific.result,
  param.detection=specificResult$param.detection, page.name="Example_SpeCond_results2",
  page.title="Tissue specific results", prefix.file="S2", sort.condition="all",
  heatmap.profile=TRUE, heatmap.expression=FALSE, heatmap.unique.profile
  =FALSE, expressionMatrix=Mexp, gene.page.info=genePageInfo)

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


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