1先决条件

BioconductorR Markdown格式是建立在上面R包r CRANpkg(“bookdown”)这反过来又依赖于rmarkdown而且pandoc编译最终输出文档。因此，除非您正在使用RStudio，否则您将需要最新版本的pandoc(> = 1.17.2)。看到Pandoc安装说明有关为您的平台安装pandoc的详细信息。

2开始

要启用Bioconductor风格在你的R Markdown小插图，你需要:

• 编辑描述通过添加

  VignetteBuilder:针织建议:BiocStyle，针织，rmarkdown

• 指定BiocStyle: html_document或BiocStyle: pdf_document作为输出格式，并在文档头中添加小插图元数据:

  ——title:“Vignette title”作者:“Vignette author”包:PackageName输出:BiocStyle::html_document Vignette: > %\VignetteIndexEntry{Vignette title} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{UTF-8}——

的装饰图案部分是为了指导R如何建立小插图。11\ VignetteIndexEntry应匹配标题你的小插图的包包含包名的字段用于在输出文档头中打印包版本。没有必要详细说明日期默认情况下，文件编译日期将自动包含。有关指定作者从属关系和摘要的详细信息，请参阅下面的部分。

BiocStyle的html_document而且pdf_document格式函数扩展了相应的原始格式rmarkdown格式，所以它们接受相同的参数html_document而且pdf_document,分别。例如，使用toc_float:真以获得浮动TOC，如本插图所示。

' ' ' {r style, echo = FALSE, results = 'asis'} BiocStyle::markdown(css。Files = c('custom.css'))' ' '

3.文档标题

作者:“单一作者”

作者:-第一作者-第二作者-最后作者

作者:-姓名:第一作者隶属关系:-共享隶属关系-附加隶属关系-姓名:第二作者隶属关系:共享隶属关系电子邮件:corresponding@author.com

作者:-名称:第一作者隶属关系:- &id共享隶属关系-附加隶属关系-名称:第二作者隶属关系:*id电子邮件:corresponding@author.com

——title: "标题页的完整标题" shorttitle: "标题的短标题" author: "Vignette author " package: PackageName abstract: >文档摘要输出:BiocStyle::pdf_document——

4风格的宏

BiocStyle介绍在参考时有用的以下宏R包:

• Biocpkg(“IRanges”)为Bioconductor软件、注释和实验数据包，包括到发布登陆页面的链接，或者如果包只在devel中，则到devel登陆页面的链接，IRanges．

• CRANpkg(“data.table”)为RCRAN上提供的软件包，包括到FHCRC CRAN镜像登录页面的链接，data.table．

• Githubpkg(“rstudio / rmarkdown”)为RGitHub上可用的包，包括到包存储库的链接，rmarkdown．

• Rpackage(“MyPkg”)为R以下的包不上可用Bioconductor， CRAN或GitHub;MyPkg．

它们被称为内联的，例如，' r Biocpkg (IRanges) '．

5代码块

输出代码块的行长被设置为最佳宽度，通常为80个字符，因此不需要手动调整选项(“宽度”)．

6数据

BiocStyle附带三种预定义的数字大小。如下面的例子所示，未特别指明的常规数字相对于段落文本缩进。

情节(汽车)

没有标题的图形只是放置在它们生成的位置R代码。如果您通过“代码块”选项将标题分配给图形fig.cap，该地块将自动标记和编号3.3.对于PDF输出，它将被放置在一个浮动数字环境，也可以引用它。这些特性由r CRANpkg(“bookdown”)，它定义了一种与格式无关的语法，用于指定交叉引用，请参见节9．图形标签是从代码块标签生成的44对于要工作的交叉引用，块标签只能包含字母数字字符(a-z, a-z, 0-9)，斜杠(/)或破折号(-)加上前缀图:例如，源于数据块的图形的标签喷火将无花果:foo．要引用图形，请使用语法\ @ref(标签)55不要忘记前面的反斜杠!,在那里标签是图形标签，例如，无花果:foo．例如，下面的代码块用于生成图1．

{r图形，fig.cap = "正则图形。第一句…"，echo = FALSE}情节(汽车)' ' '

图1:正则图
图标题的第一句被自动强调作为图标题。

除了常规数字，BiocStyle提供可由指定的小和宽图形fig.small而且fig.wide代码块选项。宽幅图与段落左对齐，并在右侧边缘延伸，如图所示2．小图形表示可能是矩形图形，这些矩形图形相对于文本列居中，参见图3.．

图2:宽图
由带有选项的代码块生成的图形fig.wide = TRUE．

图3:小的图
由带有选项的代码块生成的图形图.small = TRUE．

7表

与图表一样，带标题的表格也将被编号，并可以引用。标题输入为以。开头的段落表:66或者只是：，它可以出现在表的前面或后面。添加标签时，请确保标签出现在表单中表标题的开头(\ #标签:标签)，并使用\ @ref(标签:标签)参考它。例如，表1已使用以下代码生成。

水果|价格------- | -----香蕉| 1.2苹果| 1.0橙子| 2.5:(\#tab:table)一个简单的表。标题。

这个函数knitr: kable ()将自动为表环境生成一个标签，哪个是块标签前缀标签:，见表2．

knitr::kable(head(mtcars[， 1:8]， 10)，标题= '一个表的前10行' mtcars '。”)

8方程

若要对方程进行编号和引用，请将它们放在方程环境中，并按照语法为它们附加标签(\ #情商:标签)77由于技术上的限制，方程标签必须以情商:,例如,

f \ \}{方程开始离开(k \右)= \ binom p {n} {k} ^ k \离开(1 - p \右)^ {n - k}结束(\ #情商:binom) \{方程}

渲染下面的方程。

你可以参考方程式(1）通过\ @ref (eq binom):．注意，在HTML输出中，只有标记的方程式才会显示编号。

9交叉引用

除参考数字外(第6)，表(节7)和方程(节)8)，也可以使用相同的语法\ @ref(标签)引用章节，其中标签是section ID。默认情况下，Pandoc将为所有节头生成id，例如:#你好世界将有一个IDhello world．为了避免在更改节头后忘记更新引用标签，您还可以通过追加手动为节头分配ID{# id}到它。

当无法找到引用标签时，您将看到两个问号，如?？，并在R控制台时呈现文档。

10边注

脚注作为边注显示在右页边距上88这是作为脚注输入的边注，这样做的好处是它们看起来离它们被定义的地方很近。