1．1安装biocthis

R是一个开源的统计环境，可以很容易地修改，以增强其功能通过包。biocthis是一个R可透过Bioconductor包的存储库。R可以安装在任何操作系统上凹口之后就可以安装了biocthis在您的R会话:

如果(!requireNamespace("BiocManager"， quiet = TRUE)) {install.packages("BiocManager")} BiocManager::install("biocthis") ##检查您有一个有效的Bioconductor安装BiocManager::valid()

您可以从上面安装开发版本GitHub:

BiocManager:安装(“lcolladotor / biocthis”)

1．2所需的知识

biocthis它基于许多其他包，特别是那些已经实现了创建tidyverse风格R包所需的基础设施的包。这是usethis(Wickham and Bryan, 2021)，devtools(Wickham, Hester, and Chang, 2021)，以及testthat(韦翰,2011)。如果你熟悉它也会很有帮助斯泰勒(Müller和Walthert, 2021)。最后，我们强烈建议你跑步biocthis在RStudio桌面．

如果你问自己“我从哪里开始使用Bioconductor?”你可能会感兴趣这篇博文．

1.3寻求帮助

作为包开发人员，我们试bob电竞体育官网图清楚地解释如何使用我们的包以及以何种顺序使用函数。但R而且Bioconductor有一个陡峭的学习曲线，所以学会在哪里寻求帮助是至关重要的。上面引用的博客文章提到了一些，但我们想强调的是生物导体支持站点作为获得帮助的主要资源:记得使用biocthis标记和检查以前的帖子．其他替代方案也可用，如创建GitHub问题和twitter。但是，请注意，如果你想接受帮助，你应该坚持发布指导方针．特别重要的是，您要提供一个小的可重复的示例和会话信息，以便包开发人员可以跟踪错误的来源。bob电竞体育官网

1．4引用biocthis

我们希望biocthis对你的工作很有帮助。请使用以下信息来引用包和整体方法。谢谢你！

##引文信息引文(“biocthis”)#> #> Collado-Torres L(2021)。#> Bioconductor包的自动化包和项目设置_。doi: 10.18129 / B9.bioc。biocthis(URL: #> https://doi.org/10.18129/B9.bioc.biocthis), #> https://github.com/lcolladotor/biocthisbiocthis - R package version #> 1.2.0, . #> #> Collado-Torres L (2021). "Automate package and project setup for #> Bioconductor packages." _bioRxiv_. doi: 10.1101/TODO (URL: #> https://doi.org/10.1101/TODO),  https://www.biorxiv.org/content/10.1101/TODO>. #> #> To see these entries in BibTeX format, use 'print(, #> bibtex=TRUE)', 'toBibtex(.)', or set #> 'options(citation.bibtex.max=999)'.

2.1使用biocthis在简历中

如果您还没有创建R包，您可以使用usethis．也就是说，利用usethis: create_package ()使用您选择的包名。如果你正在使用RStudio桌面这个函数将打开一个新的RStudio窗口，并在正确的位置打开R。否则，您可能需要使用setwd ()更改目录。

在这个小插图中，我们将创建一个名为biocthispkg在一个临时目录上并在此目录下工作，以便说明函数是如何工作的。在现实场景中，您将在R包中工作，并且不会运行biocthis_example_pkg ()．

创建一个示例包用于说明目的。##注意:你不需要为你自己的包运行这个!pkgdir <- biocthis_example_pkg("biocthispkg"， use_git = TRUE) #>✔创建'/tmp/RtmpTMNDVK/biocthispkg' #>✔设置活动项目到'/tmp/RtmpTMNDVK/biocthispkg' #>✔创建'R/' #>✔写'DESCRIPTION' #> Package: biocthispkg #> Title: Package Does(一行，Title Case) #> Version: 0.0.0.9000 #> Authors@R(解析):#> * First Last  [aut, cre] (your - orcidid) #> DESCRIPTION: Package Does(一段)。#>许可证:' use_mit_license() '， ' use_gpl3_license() '或朋友选择#>许可证#>编码:UTF-8 #> LazyData: true #> Roxygen: list(markdown = true) #> RoxygenNote: 7.1.1 #>✔写“命名空间”#>✔设置活动项目到'' #>✔设置活动项目到'/tmp/RtmpTMNDVK/biocthispkg' #>✔初始化Git repo #>✔添加'. rproj。用户','。Rhistory', '.Rdata', '.httr-oauth', '.DS_Store' to '.gitignore'

一旦创建了包，就可以使用use_bioc_pkg_templates ()方法中创建一组脚本dev(开发人员)目录。

##创建生物模板biocthis::use_bioc_pkg_templates() #>✔创建'dev/' #>✔添加'^dev$' to '。Rbuildignore' #>特遣队正在写'dev/01_create_pkg。R' #>✔Writing 'dev/02_git_github_setup. R' #>特遣队R' #>✔Writing 'dev/03_core_files。R' #>✔Writing 'dev/04_update. /R '

如果你跑了use_bioc_pkg_templates ()在RStudio桌面，然后所有的脚本将打开在你的RStudio窗口。每个脚本都包含注释，这些注释将指导您执行创建bioconductor友好R包所需的步骤。这些脚本是:

• 01 _create_pkg。R
  • 帮助您安装使用这些模板脚本开发R包所需的R包。
  • 帮助您检查您选择的R包名称是否可用。
  • 包括跑步的步骤use_bioc_pkg_templates ()．
• 02 _git_github_setup。R
  • 忽略了*。Rproj文件，以符合Bioconductor的要求
  • 初始化git存储库
  • 创建相应的GitHub存储库
• 03 _core_files。R
  • 创建Bioconductor-friendly自述文件。限制型心肌病而且NEWS.md文件
  • 为问题创建生物导体友好的GitHub模板
  • 使用tidyverse风格的GitHub贡献和行为准则文件
  • 创建一个生物导体友好的模板引用文件
  • 属性中添加多个徽章自述文件。限制型心肌病文件111你可能会想用獾它也有生物导体下载统计的徽章。有些徽章是为Bioconductor量身定制的软件包，所以您必须编辑它们以获得注释、实验和工作流包。
  • 使用设置单元测试testthat(韦翰,2011)
  • 添加一个生物导体友好的GitHub动作工作流
  • 使用部署一个初始文档网站pkgdown(维克汉姆和赫塞尔伯斯出版社，2020年出版)
• 04 _update。R
  • 使用自动样式化包中的R代码斯泰勒(Müller和Walthert, 2021)
  • 使用更新文档文件devtools(Wickham, Hester, and Chang, 2021)

这些步骤中有许多是由usethis(Wickham和Bryan, 2021)，其中一些人利用biocthis(Collado-Torres, 2021)。

3．1bioc_style ()

bioc_style ()帮助您自动应用编码风格到您的R包文件使用斯泰勒(Müller and Walthert, 2021)，该研究基于Tidyverse编码风格指南但经过修改，使其更类似于生物导体编码风格指南．

# #自动风格整包装器的例子:style_pkg(添加pkgdir、变压器= biocthis: bioc_style()) # >────────────────────────────────────────# >状态数传说# >✔0文件不变。#>ℹ0文件更改。#>控制样式抛出错误。# >────────────────────────────────────────

3.2use_bioc_citation ()

use_bioc_citation ()创建一个R包引用文件在本月/引用它预先填充了您可能想要用于您的(未来)Bioconductor包(如Bioconductor DOIs)的信息，并引用了描述您的包的期刊文章(您可能会考虑提交给它)bioRxiv首先作为预印本)。另外,使用usethis: use_citation ()．

##创建一个Bioconductor-friendly biocthis::use_bioc_citation() #>✔创建“inst/”#>✔写入“inst/CITATION”#>•编辑“inst/CITATION”

3.3use_bioc_description ()

use_bioc_description ()创建一个R包描述文件中预先填充了您可能想要用于(未来)Bioconductor包的信息，如Bioconductor支持网站的链接和biocViews．您仍然需要手动编辑该文件。另外,使用usethis: use_description ()．

##创建一个生物导流友好的模板描述文件biocthis::use_bioc_description() #>✔保留“描述”不变#>包:biocthispkg #>标题:包的功能(一行，标题情况)#>版本:0.99.0 #>日期:2021-05-19 #> Authors@R(解析):#> * First Last  [aut, cre] (you - orcid - id) #>描述:包的功能(一段)。#>许可:艺术-2.0 #> URL: #> BugReports: https://support.bioconductor.org/t/biocthispkg #>编码:UTF-8 #> LazyData: true #> Roxygen: list(markdown = true) #> RoxygenNote: 7.1.1 #> biocViews:软件

3.4use_bioc_github_action ()

##创建一个GitHub Actions工作流，这是bioconductor友好的biocthis::use_bioc_github_action() #>✔Creating '。github/' #>✔Adding '^\\。Github $' to '。Rbuildignore' #> ✔ Adding '*.html' to '.github/.gitignore' #> ✔ Creating '.github/workflows/' #> ✔ Writing '.github/workflows/check-bioc.yml'

##使用usethis::edit_r_profile()打开你的。rprofile文件pkgdown" = TRUE) options("biocthis. pkgdown" = TRUE)= TRUE)

3．5use_bioc_issue_template ()

use_bioc_issue_template ()创建一个GitHub问题模板文件，其中预先填充了您可能想要用于(未来)Bioconductor包的信息，例如Bioconductor支持网站的链接，以及您可以要求用户提供的信息示例，这将使您更容易帮助您的用户。另外,使用usethis: use_tidy_issue_template ()．

##创建一个Bioconductor-friendly的GitHub issue文件模板biocthis::use_bioc_issue_template() #>✔Creating `。github/ISSUE_TEMPLATE/' #>✔Writing '.github/ISSUE_TEMPLATE/ ISSUE_TEMPLATE .md'

3.6use_bioc_news_md ()

use_bioc_news_md ()创建一个NEWS.md模板文件，其中预填充了您可能想要用于(未来)Bioconductor包的信息。另外,使用usethis: use_news_md ()．

##创建模板NEWSmd文件，bioconductivity -friendly biocthis::use_bioc_news_md() #>✔Writing 'NEWS.md'

3.7use_bioc_pkg_templates ()

在前面的主要部分中已经详细描述了这个函数。

3.8use_bioc_readme_rmd ()

use_bioc_readme_rmd ()创建一个自述文件。限制型心肌病模板文件是预先填充的信息，你可能想要使用你的(未来)Bioconductor包，如Bioconductor的安装说明，如何引用你的包和链接到你使用的开发工具。另外,使用usethis: use_readme_rmd ()．

##创建模板README。限制型心肌病文件that is Bioconductor-friendly biocthis::use_bioc_readme_rmd() #> ✔ Writing 'README.Rmd' #> ✔ Adding '^README\\.Rmd$' to '.Rbuildignore' #> ✔ Writing '.git/hooks/pre-commit'

3.9use_bioc_support ()

use_bioc_support ()创建一个模板GitHub支持模板文件，其中预填充了您可能想要用于(未来)Bioconductor包的信息，例如在哪里寻求帮助，包括Bioconductor支持网站。另外,使用usethis: use_tidy_support ()．

##创建一个模板GitHub支持文件，是bio导体友好的biocthis::use_bioc_support() #>✔写'.github/ support .md'

3.10use_bioc_vignette ()

use_bioc_vignette ()创建一个模板小插图文件，其中预填充了您可能想要用于(未来)Bioconductor包的信息。此模板包含关于如何引用使用的其他包的信息RefManageR，设计你的小插图BiocStyle例如，如何从Bioconductor安装你的软件包的说明，在哪里寻求帮助，用户在使用你的软件包之前可能需要知道的信息，以及关于小插图是如何制作的可复制性信息sessioninfo．在开发R包时，您将需要花费大量时间编辑这个小插图。另外,使用usethis: use_vignette ()．

##创建一个biocthis::use_bioc_vignette模板文件(“biocthispkg”，“biocthispkg简介”)#>✔在DESCRIPTION中添加“knitr”到建议字段#>•使用“requireNamespace(“knitr”，quiet = TRUE)”来测试是否安装了包#>•然后直接引用像“knitr::fun()”这样的函数(取代“fun()”)。使用' requireNamespace("BiocStyle"， quiet = TRUE) '来测试是否安装了包#>•然后直接引用像'BiocStyle::fun() '这样的函数(取代' fun() ')。使用' requireNamespace("RefManageR"， quiet = TRUE) '来测试是否安装了包#>•然后直接引用'RefManageR::fun() '(取代' fun() ')这样的函数。使用' requireNamespace("sessioninfo"， quiet = TRUE) '来测试是否安装了包#>•然后直接引用'sessioninfo::fun() '(取代' fun() ')这样的函数。#>✔将DESCRIPTION中的VignetteBuilder字段设置为“knitr”#>✔添加“inst/doc”到“”gitignore' #>✔创建“vignettes/”#>✔添加“*.html”，“*.html”。R'到'vignettes/。#>•使用' requireNamespace("rmarkdown"， quiet = TRUE) '测试是否安装了包#>•然后直接引用'rmarkdown::fun() '(取代' fun() ')这样的函数。写小插曲/biocthispkg。限制型心肌病的#> • Edit 'vignettes/biocthispkg.Rmd'