1简介

这个包的目的是提供工具来帮助在Rmarkdown和LaTeX文档之间进行转换，特别是在编写要提交给F1000Research的工作流的情况下，同时希望还在Bioconductor上托管一个可运行的示例。在维护单个工作文档的同时达到这两个端点可能具有挑战性。提交到日志需要一个LaTeX文件，最好通过编写基于的Rnw工作流来实现Sweave或knitr，而生成由Bioconductor托管的基于html的版本最容易从Rmarkdown文档中实现。工具如pandoc将允许多种格式之间的转换，但当旨在满足期刊出版物的特定格式要求时，仍然需要高度的人工干预。

当前的功能假设您已经在Rmarkdown中开发或计划开发一个工作流，目的是尽可能直接地创建适合提交给F1000Research的LaTeX文档。

2引用这项工作

如果你利用BiocWorkflowTools请考虑在致谢中引用其附带出版物:

王晓明，王晓明，王晓明(2018)。“使用BiocWorkflowTools创作Bioconductor工作流[版本1;推荐人:2人同意，但有保留意见。”F1000Research, 431年。doi: 10.12688 / f1000research.14399.1．

3.包安装

在我们开始之前，您需要安装库。

如果(!requireNamespace("BiocManager"， quiet =TRUE)) install.packages("BiocManager") BiocManager::install('BiocWorkflowTools')

4创建一个新的工作流文档

4．1使用RStudio和我们的模板

BiocWorkflowTools软件包附带了一个基于F1000Research提供的LaTeX文章模板的示例Rmd文件。本文定义了一篇F1000Research软件文章的文档结构，并给出了如何在Rmarkdown文档中合并表格、图表和评估代码的示例。这些示例都经过了测试，以确保可以使用这个包将它们转换为LaTeX。如果您刚刚开始开发您的工作流，这个模板是一个很好的开始。

访问它的最简单方法是在RStudio环境中工作。从这里你可以选择文件，新文件，R减价从屏幕顶部的菜单中。这将打开一个新窗口(如图所示)1）

图1:新文章的创建集成到RStudio中
F1000Research模板可以通过“new R Markdown document”菜单选项访问。

在这里你可以选择F1000Research文章，并指定新文档的名称和应该在其中创建的位置。紧迫的好吧将在此目录中创建一个新的子文件夹，其中包含几个文件。其中最重要的是.Rmd文件，该文件现在包含了开始使用的模板文档结构。该文件将在RStudio会话中自动打开。

您还将在此文件夹中找到其他四个文件。其中两个:frog.jpg而且sample.bib是示例文件，用于演示如何在文档中包含图像和引用。它是安全的删除或编辑它们，如果你对这是如何工作的舒适。剩下的两个文件:f1000_styles.sty而且F1000header.png是我们将生成的最终文章PDF格式所必需的，不应更改。

tmp_dir <- tempdir() setd (tmp_dir) rmarkdown::draft(file = "MyArticle. txt ")限制型心肌病", template = "f1000_article", package = "BiocWorkflowTools", edit = FALSE)

5转换为LaTeX和PDF

当你在撰写Rmarkdown文档时(实际上一旦完成)，你可能会想要查看期刊格式的PDF版本或获取LaTeX源代码以提交给期刊。

如果你在RStudio中工作，你可以简单地按下文档窗格顶部的“Knit”按钮。这将执行代码块，将文档转换为LaTeX，然后将其编译为PDF。所有这些文件都被保留，并且您将能够找到.tex而且. pdf与原始文件在同一文件夹中的文件.Rmd．

图2:完整的文件集
在“编织”之后，LaTeX源文件和PDF文档都可以在你的Rmarkdown文件旁边找到。

在RStudio外部工作时，可以使用命令实现相同的结果呈现()从rmarkdown包。

Rmd_file <- file。path(tmp_dir， 'MyArticle'， 'MyArticle. rmd ')::render(input = rmd_file)

6文章上传

最后，我们提供了函数uploadToOverleaf ()将项目直接上载至Overleaf (http://www.overleaf.com)，乳胶创作系统F1000Research用于他们的提交过程。这一步完全是可选的，如果您愿意，可以手动上传前面步骤创建的输出。

这里唯一的论点是文件其中，您提供包含您的.Rmd，.tex等文件。uploadToOverleaf ()将包含的文件夹压缩为zip文件，并将其提交给Overleaf，打开指向新创建项目的浏览器窗口。

library(BiocWorkflowTools) workflow_dir <- file. dllpath(tmp_dir， 'MyArticle')

从这里你会发现这篇文章的R Markdown和R Markdown版本都出现在Overleaf项目中，其中第一个被呈现在网站上看到的文档预览中。在Overleaf环境中，只有对版本的更改才会反映在预览窗格中，而不是您现在正在使用的R Markdown。在这里编辑R Markdown也是完全可能的，但是在Overleaf环境中没有办法重新生成版本，因此也没有办法重新生成PDF。由于这些原因，我们不建议在这种情况下使用Overleaf作为编辑器，而只是作为提交管道。

7R会话信息

sessionInfo ()

## R版本4.2.0 RC (2022-04-19 r82224) ##平台:x86_64-pc-linux-gnu(64位)##运行在Ubuntu 20.04.4 LTS ## ##矩阵产品:默认## BLAS: /home/biocbuild/bbs-3.15-bioc/R/lib/libRblas。/home/biocbuild/bbs-3.15-bioc/R/lib/libRlapack。所以## ## locale: ## [1] LC_CTYPE=en_US。UTF-8 LC_NUMERIC= c# # [3] LC_TIME=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 lc_phone = c# # [11] LC_MEASUREMENT=en_US。UTF-8 LC_IDENTIFICATION=C ## ##附加的基本包:## [1]stats graphics grDevices utils datasets methods基础## ##其他附加包:## [1]BiocStyle_2.24.0 ## ##通过命名空间加载(且未附加):## [1] bookdown_0.26 digest_0.6.29 R6_2.5.1 ## [4] knitr_1.38 sass_0.4.1 ## [7] highr_0.9 stringi_1.7.6 rlang_1.0.2 ## [7] cli_3.3.0 jquerylib_0.1.4 bslib_0.3.1 ## [13] rmarkdown_2.14 tools_4.2.0 string_1 .4.0 ## bbbxfun_0.30 yaml_2.3.5 fastmap_1.1.0 ## [19] compiler_4.2.0 BiocManager_1.30.17 htmltools_0.5.2 ## [22] knitr_1.38 sass_0.4.1

8鸣谢及资助

目前，德国生物信息学基础设施网络(de.NBI) Förderkennzeichen Nr. 031A537 B为该软件包的持续开发和维护提供资金。