工作流包的主要焦点是小插图!
工作流小插图是描述涉及多个生物导体包的生物信息学工作流的文档。这些工作流程通常比伴随单个Bioconductor软件包的小插曲更广泛。
工作流小插图可能处理更大的数据集和/或比典型的Bioconductor包小插图计算更密集。欧洲杯2021体育彩票由于这个原因,自动生成这些小场景的构建器没有时间限制(相比之下,Bioconductor的包构建系统如果包构建时间太长就会超时)。预计大多数小插图代码块都会被计算。
任何生物信息学领域的专家。
编写一个与工作流同名的包。用Markdown编写的工作流小插图,使用rmarkdown包应该包含在小插图目录中。您可以包含多个小插图,但请使用有用的标识名称。
该包不需要man/或R/目录,也不需要数据/目录,因为理想的工作流利用生物导体存储库或网络上的现有数据;工作流包本身不应该包含大型数据文件。
在DESCRIPTION文件中,包含一行“BiocType: Workflow”。请在Description文件中还包括一个详细的描述字段。DESCRIPTION文件应该包含biocViews,它应该来自工作流的分支。如果你认为一个新术语是相关的,请联系lori.shepherd@roswellpark.org。
将包提交给GitHub提交跟踪器进行正式审查。还请在跟踪器问题中指出这个包是一个工作流。
工作流是git版本控制的。一旦包被接受,它将被添加到我们的git仓库git@git.bioconductor.org,并将发送指令以获得访问权限以进行维护。
在标准化工作流小插图格式的努力中,强烈建议使用BiocStyle进行格式化或利用BiocWorkflowTools。下面的标题展示了如何在小插图中使用BiocStyle:
输出:BiocStyle:: html_document
也应该包括以下内容
- author affiliation -一个表示工作流小插图被修改的日期
第一部分应该有一些版本控制信息。R版本、Bioconductor版本和包版本应该可见。以下是如何实现这一点的例子:
**R version**: ' R R version。
**Package**: ' r packageVersion("annotation") '
**Bioconductor version**: ' r BiocManager::version() '
**Package**: ' r packageVersion("annotation") ' <\p>
一个工作流小插图的示例:
以下是来自变体工作流包的示例头:
- - -标题:注释基因组变异作者:- name: Valerie Obenchain隶属:Fred Hutchinson Cancer Research Center, 1100 Fairview Ave. N., P.O. Box 19024, Seattle, WA, USA 98109-1024 date: 11 April 2018 vignette: > %\VignetteIndexEntry{Annotating Genomic Variants} %\VignetteEngine{knitr::rmarkdown} output:BiocStyle::html_document - - - # Version Info ' ' {r, echo=FALSE, results="hide", warning=FALSE} suppressPackageStartupMessages({library(' versions ')}) **R version**: ' R R version '。
**Bioconductor版本**:' r BiocInstaller::biocVersion() '
**Package version**: ' r packageVersion(" versions ") '
. aspx . aspx . aspx
大多数工作流都会加载许多包,您不希望加载这些包的输出会使您的工作流文档混乱。以下是你在降价时如何解决这个问题的方法;你可以在Latex中做类似的事情。
首先,设置一个代码块,该代码块被求值但不回显,其结果被隐藏。我们还设置警告= FALSE
为了确保这个块的输出不会在文档中结束:
“‘{r,回声= FALSE,结果=“隐藏”,警告= FALSE} suppressPackageStartupMessages({库(GenomicRanges)库(GenomicAlignments)图书馆(Biostrings)图书馆(Rsamtools)图书馆(ShortRead)图书馆(BiocParallel)图书馆(rtracklayer)图书馆(VariantAnnotation)图书馆(AnnotationHub)图书馆(BSgenome.Hsapiens.UCSC.hg19)库(RNAseqData.HNRNPC.bam.chr14)})' ' '
然后你可以建立另一个代码块是echo,内容几乎相同。第二次调用图书馆()
不会产生任何输出,因为包已经被加载了:
{r}库(基因组范围)库(genome ranges)库(genome alignments)库(Biostrings)库(Rsamtools)库(ShortRead)库(BiocParallel)库(rtracklayer)库(VariantAnnotation)库(AnnotationHub)库(bsgenome . hapiens . ucsc .hg19)库(RNAseqData.HNRNPC.bam.chr14)' ' '
要管理工作流文档中的引用,请在文档元数据头中指定书目文件。
参考书目:references.bib
然后可以使用[@label]形式的引用键来引用标识符为“label”的条目。
通常情况下,你会想用“References”或类似的节标题来结束你的文档,之后会附加参考书目。
有关详细信息,请参见rmarkdown文档。
如果您有任何问题,请询问生物发展邮件列表。