1介绍

这个包的目的是提供工具来协助Rmarkdown和乳胶文档之间的转换,特别是如果一个是写一个工作流提交给F1000Research,同时希望托管Bioconductor runable例子。达到这两个端点,同时保持一个可以挑战的工作文档。提交《需要乳胶文件,最好是通过编写一个基于Rnw工作流Sweave或knitr,而生产基于html版本由Bioconductor是从一个Rmarkdown文档最容易实现。工具,如pandoc将允许许多格式之间的转换,但仍然是一个高度的手动干预计划时需要满足的特定格式要求的期刊出版。

假设您已经开发出目前的功能,或计划开发,在Rmarkdown工作流,旨在使乳胶文档的创建适合提交F1000Research尽可能简单。

我们可以开始之前您需要安装图书馆。

源(“//www.andersvercelli.com/biocLite.R”) biocLite (“BiocWorkflowTools”)

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

2.1使用RStudio和模板

BiocWorkflowTools包提供了一个示例限制型心肌病文件基于乳胶由F1000Research文章模板。本文定义了F1000Research软件的文档结构,并给出了如何合并表的例子,数据和评估代码Rmarkdown文档。这些例子都被测试,以确保他们可以使用这个包被转换成乳胶。如果你是刚开始开发您的工作流,这个模板是一个很好的起点。

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

图1:创建一个新的文章是集成到RStudio
F1000Research模板可以通过访问“新R减价文档”菜单选项。

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

你还会发现其他四个文件在这个文件夹中。其中两个:frog.jpg和sample.bib示例文件,用于演示如何在文档中包含图片和参考。删除或编辑它们是安全如果你满意这是如何工作的。剩下的两个文件:f1000_styles.sty和F1000header.png所需的最后一篇文章格式的PDF生成和不应该被改变。

tmp_dir < - tempdir () setwd (tmp_dir) rmarkdown::(文件= " MyArticle草案。限制型心肌病”,模板= " f1000_article”,包= " BiocWorkflowTools”,编辑= FALSE)

3乳胶和PDF转换

当你写你的Rmarkdown文档(事实上一旦完成),您可能想查看期刊格式的PDF版本或获得一个乳胶来源提交《华尔街日报》。

如果你工作在RStudio只需按下“编织”按钮面板顶部的文档。这将执行代码块,将文档转换为乳胶,然后编译这个PDF。保留这些文件,你将能够找到的.tex和. pdf与原始文件在同一文件夹.Rmd。

图2:完整的一套文件
“编织”后乳胶源文件和PDF文档可以找到与你Rmarkdown文件。

RStudio以外的工作,你可以通过使用命令实现相同的结果呈现()从rmarkdown包。

rmd_file < -文件。路径(tmp_dir MyArticle, MyArticle.Rmd) rmarkdown::渲染(输入= rmd_file)

4文章上传

最后,我们提供的函数uploadToOverleaf ()直接上传项目在背面(http://www.overleaf.com),F1000Research乳胶编写系统使用的提交过程。这一步是完全可选的,和前面的步骤中创建的输出可以手动上传。

的主要论点文件你给目录包含您的位置.Rmd,.tex等书面文件。uploadToOverleaf ()将包含文件夹压缩成zip文件,并提交在背面。如果上传成功将返回一个URL,如果你使用的论点openInBrowser = TRUE将打开一个浏览器窗口的新项目。从这里你可以提交你的文章《华尔街日报》。

库(BiocWorkflowTools) workflow_dir < -文件。路径(tmp_dir MyArticle) uploadToOverleaf(文件= workflow_dir openInBrowser = TRUE)

5R会话信息

sessionInfo ()

3.4.4 # # R版本(2018-03-15)# #平台:x86_64-pc-linux-gnu(64位)# #下运行:Ubuntu 16.04.4 LTS # # # #矩阵产品:默认# #布拉斯特区:/home/biocbuild/bbs - 3.6 - bioc / R / lib / libRblas。所以# # LAPACK: /home/biocbuild/bbs - 3.6 - bioc / R / lib / libRlapack。# # # #语言环境:# # [1]LC_CTYPE = en_US。utf - 8 LC_NUMERIC = C # #[3]而= en_US。utf - 8 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.6.1 # # # #通过加载一个名称空间(而不是附加):# # [1]Rcpp_0.12.16 bookdown_0.7 digest_0.6.15 rprojroot_1.3-2 # # [5] backports_1.1.2 magrittr_1.5 evaluate_0.10.1 highr_0.6 # # [9] stringi_1.1.7 rmarkdown_1.9 tools_3.4.4 stringr_1.3.0 # # [13] xfun_0.1 yaml_2.1.18 compiler_3.4.4 htmltools_0.3.6 # # [17] knitr_1.20