1先决条件

BioconductorR减价格式是建立之上R包bookdown,进而依靠rmarkdown和pandoc编制最终的输出文档。因此,除非你使用的是RStudio,你需要一个最新版本的pandoc(> = 1.17.2)。看到pandoc安装说明有关安装pandoc为您的平台。

2开始

要启用Bioconductor风格在你的R减价装饰图案,你需要:

  • 编辑描述文件通过添加

    VignetteBuilder: knitr表明:BiocStyle knitr rmarkdown

  • 指定BiocStyle: html_document或BiocStyle: pdf_document输出格式和添加装饰图案的元数据文档中标题:

    - - -标题:“小插图标题”作者:“小插图作者”包:PackageName输出:BiocStyle: html_document装饰图案:> % \ VignetteIndexEntry{小插图标题}% \ VignetteEngine {knitr:: rmarkdown} % \ VignetteEncoding {utf - 8} - - - - - -

的装饰图案部分需要以指导R如何构建装饰图案。1\ VignetteIndexEntry应该匹配标题你的小插图的包场应该包含包的名称是用来打印输出文档头包版本。没有必要指定日期作为默认文档编译日期将自动包括在内。有关详细信息,请参阅下一节指定作者的从属关系和抽象。

BiocStyle的html_document和pdf_document扩展相应的原始格式功能rmarkdown格式,所以他们接受相同的参数html_document和pdf_document,分别。例如,使用toc_float:真获得一个浮动的TOC作为装饰图案。

2.1使用R减价v1

除了默认的减价引擎中实现r CRANpkg (“rmarkdown”)包,也可以编译Bioconductor文件包的大减价v1引擎r CRANpkg(“减价”)。有一些设置和结果输出之间的差异这两个引擎。

使用减价装饰图案builder引擎:

  • 编辑描述文件包括

    VignetteBuilder: knitr表明:BiocStyle knitr

  • 指定装饰图案引擎.Rmd文件(在HTML注释)

    < !- % % \ VignetteEngine {knitr:: knitr} - - >

  • 添加下面的代码块的开始.Rmd小插曲

    ' ' ' {r风格,呼应= FALSE,结果=‘黑名单’}BiocStyle::减价()' ' '

当使用附加的CSS文件减价不同于这是如何实现的rmarkdown。在前一种情况下可以使用额外的样式表提供它们BiocStyle:减价函数。包括custom.css文件使用

' ' ' {r风格,呼应= FALSE,结果=‘黑名单’}BiocStyle::减价(css。文件= c (custom.css))' ' '

3文档标题

3.1作者的从属关系

的作者字段允许指定作者的名字以及联系和电子邮件信息。

在基本情况下,当没有提供额外的信息除了作者名,这些可以作为一个单独的字符串输入

作者:“作者”

或者一个列表

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

这将打印为“第一作者,第二作者,最后作者”。

作者的从属关系和电子邮件可以进入命名作者列表的子列表。可以指定多个从属关系/作者。

作者:名字:第一作者联系:-共享关系-额外的关系名称:第二作者归属:共享联系电子邮件:corresponding@author.com

独特的从属关系的列表将会显示以下作者,类似如本文档。

清晰,简洁,避免错误,重复节点在YAML头可以最初用锚进入& &,后来用星号*引用。例如,上述关系元数据相当于速记符号

作者:名字:第一作者联系:- id共享关系-额外的关系名称:第二作者归属:* id发送电子邮件至:corresponding@author.com

3.2抽象的和运行的头

抽象可以输入对应字段的文档前,如以下示例。

- - -标题:标题页“全称”shorttitle:“短标题头”作者:“小插图作者”包:PackageName文摘:>文档汇总输出:BiocStyle:: pdf_document - - - - - -

的shorttitle选项指定运行中使用的标题标题而不是文档标题。2只有相关的PDF输出

4风格的宏

BiocStyle介绍了以下指时宏有用R包:

  • Biocpkg (“IRanges”)为Bioconductor包软件,注释和实验数据,包括发布的链接登陆页面或者包只是在重击,重击的着陆页,IRanges。

  • CRANpkg (“data.table”)为R在凹口包可用,包括链接FHCRC凹口镜着陆页,data.table。

  • Githubpkg (“rstudio / rmarkdown”)为R在GitHub包可用,包括包的链接库,rmarkdown。

  • Rpackage (“MyPkg”)为R包,不上可用Bioconductor、凹口或GitHub;MyPkg。

这些是称为内联,例如,' r Biocpkg (IRanges) '。

5代码块

行输出代码块的长度设置为最优的宽度通常80个字符,所以没有必要手动调整选项(“宽度”)。

6数据

6.1简单的数据

BiocStyle有三个预定义的图尺寸。常规数据不指定出现缩进段落文本,如以下示例。

情节(汽车)

默认大小的示例图没有标题。

6.2图标题

数据没有字幕,和上面一样,只是把他们中生成的地方R代码。如果你指定一个标题图通过代码块的选择fig.cap,情节将自动标记和编号3PDF输出,它将被放置在一个浮动的数字环境,它将也可以引用它。这些特性提供bookdown定义了一个format-independent语法指定交叉引用,看到部分9。图标签生成的代码块标签4交叉引用工作块标签可能只包含字母数字字符(a - z、a - z 0 - 9)、斜杠(/),或破折号(-)通过加前缀图:的标签,例如图来自块喷火将无花果:foo。参考图,使用语法\ @ref(标签)5不要忘记领先的反斜杠!,在那里标签是图的标签,例如,无花果:foo。例如,下面的代码块是用于生产图1。

' ' ' {r情节,fig.cap =“普通人物。第一句话……”,回声= FALSE}情节(汽车)' ' '
正则图。的第一句话图标题自动强调作为图标题。

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

6.3选择图大小

除了常规的数据,BiocStyle提供小和宽可以指定的数据fig.small和fig.wide代码块的选择。大数据是左对齐的段落在右边距和扩展,如图2。小数据意味着可能矩形块集中对文本列,见图3。

广泛的图。一块由一个代码块选项的无花果。宽= TRUE”。

图2:宽图
一块由一个代码块的选择fig.wide = TRUE。

小的图。一块由一个代码块选项的无花果。小= TRUE”。

图3:小的图
一块由一个代码块的选择fig.small = TRUE。

6.4可访问性的考虑

Alt文本使用屏幕阅读器(替代)提供一个图像的描述视障读者。如果你提供一个图说明fig.cap相同的文本将自动作为图像的alt文本。然而,如果你想要包括一个图像没有标题,或您希望提供不同的信息在alt文本标题,这可以通过完成fig.alt代码块的选择。作为一个例子,下面的代码块用于包括第一图像显示在这一节中,所以它的意图传达给某人使用屏幕阅读器。

' ' ' {r没有帽,fig.alt =“默认大小的图没有说明例子。”}情节(汽车)' ' '

你也可以考虑使用的颜色在你的数据,以确保它们颜色受损的读者理解。BiocStyle没有提供一个特定的颜色,但许多选项可用包的凹口。也有重大的努力改善所提供的默认颜色面板()在R-4.0.0。Bioconductor包含一些领域特定的包关注色盲友好的可视化。dittoSeq单细胞和散装RNA-sequencing数据。

7表

像数据,表标题也会编号,可以引用。输入标题作为一个段落开始表:6或者只是:,这可能会出现之前或之后表。当添加标签,确保标签出现在表单中的表格标题的开始(\ #标签:标签),并使用\ @ref(标签:标签)来引用它。例如,表1使用以下代码。

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

这个函数knitr: kable ()会自动生成一个标签为一个表的环境,这是块标签前缀标签:,见表2。

knitr:: kable(头(mtcars[1:8], 10),标题=“前10的表行”mtcars”。”)

表2: 表的第一个10行mtcars。
英里/加仑 共青团 disp 惠普 见鬼 wt qsec vs
马自达RX4 21.0 6 160.0 110年 3.90 2.620 16.46 0
马自达RX4摇 21.0 6 160.0 110年 3.90 2.875 17.02 0
日产710 22.8 4 108.0 93年 3.85 2.320 18.61 1
大黄蜂4开 21.4 6 258.0 110年 3.08 3.215 19.44 1
大黄蜂Sportabout 18.7 8 360.0 175年 3.15 3.440 17.02 0
勇敢的 18.1 6 225.0 105年 2.76 3.460 20.22 1
喷粉机360 14.3 8 360.0 245年 3.21 3.570 15.84 0
芝加哥商业交易所240 d 24.4 4 146.7 62年 3.69 3.190 20.00 1
芝加哥商业交易所230 22.8 4 140.8 95年 3.92 3.150 22.90 1
芝加哥商业交易所280 19.2 6 167.6 123年 3.92 3.440 18.30 1

8方程

数量和参考方程,把它们放在方程环境和标签附加到它们的语法(\ #情商:标签)7由于技术限制方程标签必须开始情商:,例如,

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

呈现以下方程。

\[开始\{方程}f \左(k \右)= \ binom p {n} {k} ^ k \离开(1 - p \右)^ {n - k}{1} \ \标签结束{方程}\]

你可以参考方程(1)通过\ @ref (eq binom):。注意,在HTML输出只有方程将出现编号的标签。

9交叉引用

除了引用数据(部分6),表(部分7)和方程(部分8),你也可以使用相同的语法\ @ref(标签)引用部分,在那里标签是部分ID。默认情况下,Pandoc将生成ID节标题,例如,# Hello World将会有一个IDhello world。为了避免忘记更新参考标签更改部分标题后,你也可以手动指定一个ID附加一段头{# id}到它。

当一个引用标签不能被发现,你会看到两个问号? ?以及一条警告消息R控制台在呈现文档。

10边注

脚注显示为右边的笔记8这是一个边注进入一个脚注,它的优点是他们接近他们定义的地方出现。

会话信息

这里的输出sessionInfo ()本文档对系统的编译运行pandoc 2.5:

# # R版本以下4.4.1(2021-08-10)# #平台:x86_64-pc-linux-gnu(64位)# #下运行:Ubuntu 20.04.3 LTS # # # #矩阵产品:默认# #布拉斯特区:/home/biocbuild/bbs - 3.14 - bioc / R / lib / libRblas。所以# # LAPACK: /home/biocbuild/bbs - 3.14 - bioc / R / lib / libRlapack。# # # #语言环境:# # [1]LC_CTYPE = en_US。utf - 8 LC_NUMERIC = C # #[3]而= en_GB LC_COLLATE = C # # [5] LC_MONETARY = en_US。utf - 8 LC_MESSAGES = en_US。utf - 8 # # [7] LC_PAPER = en_US。utf - 8 LC_NAME = C # # [9] LC_ADDRESS C = C LC_TELEPHONE = # # [11] LC_MEASUREMENT = en_US。utf - 8 LC_IDENTIFICATION = C附加基本包:# # # # # #[1]统计图形grDevices跑龙套数据集方法基础# # # #其他附加包:# # [1]BiocStyle_2.22.0 # # # #通过加载一个名称空间(而不是附加):# # [1]Rcpp_1.0.7 bookdown_0.24 digest_0.6.28 # # [4] R6_2.5.1 jsonlite_1.7.2 magrittr_2.0.1 # # [7] evaluate_0.14 highr_0.9 stringi_1.7.5 # # [10] rlang_0.4.12 jquerylib_0.1.4 magick_2.7.3 # # [13] bslib_0.3.1 rmarkdown_2.11 tools_4.1.1 # # [16] stringr_1.4.0 xfun_0.27 yaml_2.2.1 # # [19] fastmap_1.1.0 compiler_4.1.1 BiocManager_1.30.16 # # [22] htmltools_0.5.2 knitr_1.36 sass_0.4.0