2.2.1安装

BiocWorkflowTools可以通过在R会话中运行以下命令从Bioconductor包存储库中获得。

如果(!"BiocManager" %in% rownames(installed.packages()) install.packages("BiocManager") BiocManager::install("BiocWorkflowTools")

2.2.2创建Bioconductor工作流包

考虑到背后的原因BiocWorkflowTools的为了尽可能轻松地满足两个出版平台的不同要求，我们推荐的策略假设大多数作者在开始一个项目时都打算将最终结果提交给Bioconductor和F1000Research。

对于f1000研究所需的材料清单是直接和熟悉的:文章本身，参考文献，图表和补充材料的列表。然后可以将这些文件作为文件集合发送。当涉及到生物导体时，所有相同的材料都是必需的;然而，他们的计算基础设施，使定期文件检查和易于分发，也要求提交以R包的形式。有许多资源讨论如何创建R包韦翰(2015)(如果潜在的作者不熟悉编写包，我们强烈建议他们阅读这些)，但是为了简化这个过程，我们提供了这个函数createBiocWorkflow，它将创建提交给Bioconductor所需的最小文件夹结构。

workflow_location <- file.path(tempdir()， "MyWorkflow") createworkflowtools::createBiocWorkflow(path = workflow_location, open = FALSE)

##包:MyWorkflow ##标题:包做什么(一行，标题大小写)##版本:0.0.0.9000 ## Authors@R(解析):## * First Last  [aut, cre] (YOUR-ORCID-ID) ##描述:包做什么(一段)。##许可:' use_mit_license() '， ' use_gpl3_license() '或朋友选择一个##许可##编码:UTF-8 ## LazyData: true ## Roxygen: list(markdown = true) ## RoxygenNote: 7.1.1 ##工作流:true

运行上面的示例将创建一个名为MyWorkflow子目录小插曲包含一个名为MyWorkflow。限制型心肌病．在这个文件中，应该开始开发工作流文档。在初始状态下，模板提供了典型工作流文章的示例框架，以及如何包含特定文档特征的示例，如图表、表格、公式和代码块，与F1000Research网站上提供的更传统的Microsoft Word模板的方式大致相同。该模板还包括所需文档头的示例，其中指定了文章元数据，如标题、作者名称、它们的从属关系和摘要。

在上面的例子中，改变参数open = TRUE将在新创建的RStudio中打开一个新的RStudio项目MyWorkflow文件夹中。

2.2.3只编写一个工作流文档

如果你不想做一个完整的软件包，而是简单地使用R Markdown来撰写一篇F1000Research文章，对于大多数作者来说，推荐的平台仍然是在RStudio中工作。用户可以选择从文件菜单中创建一个新的R Markdown文档，而不是像以前那样创建一个新的包BiocWorkflowTools软件包安装完成后，将显示使用F1000Research Article模板的选项(图1)1）.

图1:新文章的创建集成到RStudio中
F1000Research模板可以通过“New R Markdown”文件菜单对话框访问

这将自动打开一个基于前面描述的F1000Research模板的新文档。

rmd_file <- rmarkdown::draft("MyArticle。限制型心肌病", template = "f1000_article", package = "BiocWorkflowTools", edit = FALSE)

2.2.4转换为

如果您正在使用RStudio编辑您的工作流，创建文档版本的最简单方法是按下工作区中文档窗格上方的“Knit”按钮。这将处理文档并生成版本和编译后的PDF，这样您就可以看到最终打印版本的外观。这个过程还执行一些必要的清理工作，例如将所需的F1000Research样式文件和日志标识复制到与文档相同的位置，这样您可能会注意到出现了一些额外的文件。

如果您更喜欢在RStudio以外的编辑器中工作，仍然可以使用该函数将R Markdown文件转换为(以及前面提到的家政)渲染从rmarkdown包中。这将执行与使用RStudio相同的转换过程，执行代码块并生成预期的和PDF输出文件。

rmarkdown:渲染(rmd_file)

2.2.5文章提交

理想情况下，工作流提交给Bioconductor和F1000Research。为Bioconductor贡献的说明可从//www.andersvercelli.com/2021欧洲杯体育投注开户developers/how-to/workflows．

向F1000Research提交文章目前使用Overleaf.com，这是一个在线协作写作和出版工具。完整的细节可以在网上找到，但是假设一个人已经编写了R Markdown工作流并生成了源文件，他们可以选择使用他们的网络浏览器直接将文件上传到Overleaf。

BiocWorkflowTools提供功能uploadToOverleaf作为另一种选择，让文章进入背页系统。这个函数获取文档目录并将其发送到Overleaf，自动为您创建一个新项目。该函数将直接在web浏览器中打开新项目。

BiocWorkflowTools:: uploadToOverleaf(“MyArticle”)

在这一点上，重要的是要指出文章的R Markdown和R Markdown版本都出现在Overleaf项目中，其中第一个版本被呈现在网站上看到的文档预览中。在Overleaf环境中，只有对版本的更改才会反映在预览窗格中，而不是作者一直在使用的R Markdown。因此，如果使用浏览器界面进行编辑，两个文档很容易不同步。因此，我们建议在最终提交过程中只使用Overleaf，在这一点上避免使用它的文档编辑功能。Overleaf提供了许多吸引人的特性，例如作者之间的协作编辑(特别是那些可能不熟悉RStudio环境的作者)和实时呈现更改。然而，应该再次强调的是，尽管人们很想在Overleaf环境中编辑文档，但这会破坏背后的动机BiocWorkflowTools．因此，我们的建议是专门处理文章的R Markdown版本(使用作者喜欢的任何版本控制系统和协作工具)，然后将Overleaf纯粹用作提交门户。

2.2.6款文章修改

假设文章被暂时接受，期刊编辑将创建第二个私有的Overleaf存储库，用于较小的副本编辑。编辑的评论和指示将包括在R Markdown文档中，包含在评论标签中。<！——编辑评论——>．

在这个阶段，人们可以在web浏览器界面中编辑R Markdown文档，但是目前没有办法从这里重新生成包含更改的文档。相反，要在创建了一个Overleaf项目之后进行额外的更改，我们建议利用所有的Overleaf项目都可以被接口使用这一事实git．Overleaf提供了在本地机器上初始化它的说明, n.d. (Overleaf.com)。．由于这是一个私人项目，作者将需要提供他们的Overleaf用户名和密码来使用git。如果文稿已经在git版本控制下，则可以将Overleaf服务器添加为额外的远程存储库。然后作者可以脱机处理手稿，并使用常规的git命令来保持本地副本的同步，例如git拉获取最新版本。在提交对源Rmd文件所做的任何编辑之前，还记得重新生成输出文件。一旦他们准备好将更改推回Overleaf，他们将立即出现在网上。

cd MyArticle git pull #做一些修改并重新生成Latex文件git commit -a -m "My editing " git push

一旦作者发表了编辑的评论，就可以通过Overleaf重新提交。