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

loveR

htmlpage(annotate)
htmlpage()所属R语言包：annotate

                                        Functions to build HTML pages
                                         建立HTML页面的功能，

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

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

This function is designed to create an HTML table containing both static information as well as links to various online annotation sources.
此功能旨在创建一个HTML表格，包含静态信息以及链接到各种网上标注来源。


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


htmlpage(genelist, filename, title, othernames, table.head,
         table.center = TRUE, repository = list("en"), ...)



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

参数：genelist
A list or data.frame of character vectors containing ids to be made into hypertext links. See details for more information.
列表或data.frame包含超文本链接的IDS的特征向量。详情请参阅更多信息。


参数：filename
A filename for the resultant HTML table.
由此产生的HTML表的文件名。


参数：title
A title for the table.
表的标题。


参数：othernames
A list or data.frame of other things to add to the table. These will not be hyperlinks. The list of othernames can contain vectors, matrices, data.frames or lists.
一个列表或data.frame添加到表中的其他事情。这些将不会超链接。列表othernames可以包含向量，矩阵，data.frames或列表。


参数：table.head
A character vector of column headers for the table.
为表列标题的字符向量。


参数：table.center
Center the table? Defaults to TRUE.
中心表？ TRUE默认。


参数：repository
A list of repositories to use for creating the hypertext links. Currently available repositories include 'gb' (GenBank), 'en' (EntrezGene), 'omim' (Online Mendelian Inheritance in Man), 'sp' (SwissProt), 'affy' (Affymetrix), 'ug' (UniGene), 'fb' (FlyBase), 'go' (Gene Ontology), 'ens' (Ensembl). Additional repositories can easily be added. See setRepository for more information.
一个用于创建超文本链接库列表。目前可用的资料库包括GB（GenBank登录号），“恩”（EntrezGene），“OMIM（孟德尔遗传在线人），”SP“（SwissProt数据库），”affy（Affymetrix公司），“UG”（UniGene的）， “FB”（果蝇），“走出去”（基因本体论），“ENS”（Ensembl的）。可以很容易地添加额外的库。看到setRepository更多信息。


参数：...
Further arguments to be passed. See details for more information.
通过进一步的论据。详情请参阅更多信息。


Details

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

This function will accept a list or data.frame of character vectors, each containing different ids that are to be turned into hyperlinks (e.g., a list containing affy ids, genbank accession numbers, and Entrez Gene ids). For instances where there are more than one id per gene, use a sub-list of character vectors. See the vignette 'HowTo: Get HTML Output' for more information. Othernames should be a list or data.frame. Again, if there are multiple entries for a given gene, use a sub-list. This is more easily explained using an example - please see the examples section below and the above mentioned vignette.
这个函数将接受一个列表或data.frame字符向量，每个都包含不同的ID，要转向到超链接（例如，一个列表，其中包含IDS affy，GenBank登录号，Entrez基因IDS）。对于有多个基因ID的情况下，使用一个字符向量的子列表。看到小插曲“HOWTO：获取HTML输出的更多信息。 othernames应该是一个列表或data.frame。再次，如果有一个特定基因的多个条目，使用一个子列表。这更容易解释用一个例子 - 请参阅下文的例子和上面提到的小插曲。

In even the simplest case the genelist, othernames and repository have to be lists. A simple character vector will not suffice.
即使在最简单的例子的genelist，othernames和库必须是列表。一个简单的字符向量是不够的。

Note that this function now uses xtable to create the HTML table, and there is the ability to pass some arguments on to either xtable or print.xtable. One such argument would be 'append=TRUE', which would allow one to put lots of tables in one page, as long as the filename argument remained the same.
请注意，此功能现在使用xtable创建HTML表，并有能力通过一些参数，要么xtable或print.xtable。这样的一个论点是“追加= TRUE”，这将使一个放在一个页表的地段，只要filename参数保持不变。

Additionally, the Ensembl repository needs a species argument in order to form a usable URI. This argument can be passed in the form of e.g., species = "Homo\_sapiens". Note the capitalization of the genus, and the separation by an underscore (\_).
此外，Ensembl的仓库需要一个物种的参数，以形成一个可用的URI。例如，物种=“智人\ _sapiens”的形式，这种说法，可以通过。注意属资本化，并分离下划线（\ _）。


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

This function is used only for the side effect of creating an HTML table.
此功能仅用于创建一个HTML表的副作用。


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


Robert Gentleman <rgentlem@fhcrc.org>, further
modifications by James W. MacDonald <jmacdon@med.umich.edu>



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


  library("annotate")
  ## A very simple example. Two columns, one with links, the other without.[＃一个非常简单的例子。两列，其中一个环节，没有其他。]

  gos <- paste("GO:000000", 1:9, sep="")
  notlinks <- LETTERS[1:9]

  htmlpage(list(gos), "simple.html", "Two column data", list(notlinks),
           c("GO IDs", "Letters"), repository = list("go"))

  if(!interactive())
    file.remove("simple.html")

  ## A more complex example with multiple links per cell[＃每个单元的多个环节更复杂的例子]
  ## first we create data to annotate[＃我们首先创建数据来注释]
  unigene <- list("Hs.600536",c("Hs.596913","HS.655491"),"Hs.76704")
  refseq <- list(c("NM_001030050", "NM_001030047", "NM_001648",
  "NM_001030049"), "NM_000860", c("NM_001011645", "NM_000044"))
  entrez <- c("354", "3248", "367")
  genelist <- list(unigene, refseq, entrez)

  ## now some other data[＃现在其他一些数据]

  symb <- c("KLK3","HPGD","AR")
  desc <- c("Prostate-specific antigen precursor",
            "15-hydroxyprostaglandin dehydrogenase",
            "Androgen receptor")
  t.stat <- c(40.21, -22.14, 21.56)
  p.value <- rep(0,3)
  fold.change <- c(3.54, -2.35, 3.18)
  expression <- matrix(c(11.78, 11.69, 11.62, 8.17, 5.78, 5.58, 5.68,
                         8.26, 9.08, 9.28, 9.19, 6.05), ncol=4, byrow=TRUE)

  otherdata <- list(symb, desc, t.stat, p.value, fold.change, expression)
  table.head <- c("UniGene", "RefSeq", "EntrezGene", "Symbol",
                  "Description", "t-stat", "p-value", "fold change",
                  paste("Sample", 1:4))

  htmlpage(genelist, "test.html", "Some gene expression data", otherdata,
           table.head, repository = list("ug","gb","en"))

  if(!interactive())
    file.remove("test.html")

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


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