Project Icon

usethis

R项目和包开发工作流程自动化工具

usethis是一款为R项目和包开发而设计的工作流程自动化工具。它通过自动化项目设置和开发过程中的重复性任务,适用于R包和非包项目。usethis提供了一系列use_*()函数,用于快速创建项目结构、设置许可证、管理依赖、创建文档和测试文件等。这个工具的交互式提示和自动化操作提高了R项目开发的效率和一致性。

usethis usethis 网站

R-CMD-check CRAN 状态 生命周期:稳定 Codecov 测试覆盖率

usethis 是一个工作流程包:它自动化了在项目设置和开发过程中出现的重复性任务,适用于 R 包和非包项目。

安装

从 CRAN 安装 usethis 的发布版本:

install.packages("usethis")

或者从 GitHub 安装开发版本:

# install.packages("pak")
pak::pak("r-lib/usethis")

使用

大多数 use_*() 函数在活动项目上操作:实际上就是你计算机上的一个目录。如果你刚刚使用 usethis 创建了一个新的包或项目,那就是活动项目。否则,usethis 会验证当前工作目录是否为有效的项目目录或其子目录,然后将其设为活动项目。使用 proj_get()proj_sitrep() 手动查询项目,并在文档中阅读更多内容

少数 usethis 函数与项目没有强关联,它们会要求你提供路径。

usethis 非常健谈,会解释它正在做什么并为你分配任务。 表示 usethis 已经为你完成的事项。 表示你需要自己完成一些工作。

以下是 usethis 如何帮助设置包的快速概览。但请记住,许多 usethis 函数也适用于非包的分析项目。

library(usethis)

# 创建新包 -------------------------------------------------
path <- file.path(tempdir(), "mypkg")
create_package(path)
#> ✔ 创建 '/tmp/RtmpCJHMlj/mypkg/'。
#> ✔ 将活动项目设置为 "/private/tmp/RtmpCJHMlj/mypkg"。
#> ✔ 创建 'R/'。
#> ✔ 写入 'DESCRIPTION'。
#> Package: mypkg
#> Title: 包的功能(一行,标题大小写)
#> Version: 0.0.0.9000
#> Authors@R (parsed):
#>     * First Last <first.last@example.com> [aut, cre] (YOUR-ORCID-ID)
#> Description: 包的功能(一段话)。
#> License: 使用 `use_mit_license()`、`use_gpl3_license()` 或其他函数选择许可证
#> Encoding: UTF-8
#> Roxygen: list(markdown = TRUE)
#> RoxygenNote: 7.3.2
#> ✔ 写入 'NAMESPACE'。
#> ✔ 将活动项目设置为 "<无活动项目>"。
# 仅在此会话不是交互式时需要
proj_activate(path)
#> ✔ 将活动项目设置为 "/private/tmp/RtmpCJHMlj/mypkg"。
#> ✔ 将工作目录更改为 '/tmp/RtmpCJHMlj/mypkg/'

# 修改描述文件 ----------------------------------------------
use_mit_license("My Name")
#> ✔ 将 "MIT + file LICENSE" 添加到 'License' 中。
#> ✔ 写入 'LICENSE'。
#> ✔ 写入 'LICENSE.md'。
#> ✔ 将 "^LICENSE\\.md$" 添加到 '.Rbuildignore'。

use_package("ggplot2", "Suggests")
#> ✔ 将 ggplot2 添加到 DESCRIPTION 的 'Suggests' 字段。
#> ☐ 使用 `requireNamespace("ggplot2", quietly = TRUE)` 测试是否安装了 ggplot2。
#> ☐ 然后直接使用 `ggplot2::fun()` 引用函数。

# 设置其他文件 -------------------------------------------------
use_readme_md()
#> ✔ 写入 'README.md'。
#> ☐ 更新 'README.md' 以包含安装说明。

use_news_md()
#> ✔ 写入 'NEWS.md'。

use_test("my-test")
#> ✔ 将 testthat 添加到 DESCRIPTION 的 'Suggests' 字段。
#> ✔ 将 "3" 添加到 'Config/testthat/edition'。
#> ✔ 创建 'tests/testthat/'。
#> ✔ 写入 'tests/testthat.R'。
#> ✔ 写入 'tests/testthat/test-my-test.R'。
#> ☐ 编辑 'tests/testthat/test-my-test.R'。

x <- 1
y <- 2
use_data(x, y)
#> ✔ 将 R 添加到 DESCRIPTION 的 'Depends' 字段。
#> ✔ 创建 'data/'。
#> ✔ 在 'DESCRIPTION' 中将 'LazyData' 设置为 "true"。
#> ✔ 将 "x" 和 "y" 保存到 "data/x.rda" 和 "data/y.rda"。
#> ☐ 为你的数据编写文档(参见 <https://r-pkgs.org/data.html>)。

# 使用 git ------------------------------------------------------------
use_git()
#> ✔ 初始化 Git 仓库。
#> ✔ 将 ".Rproj.user"、".Rhistory"、".Rdata"、".httr-oauth"、".DS_Store" 和
#>   ".quarto" 添加到 '.gitignore'。

行为准则

请注意,usethis 项目发布时附带贡献者行为准则。通过为该项目做出贡献,你同意遵守其条款。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号