RStudio Markdown 辅助工具——remedy 项目教程

RStudio Markdown 辅助工具——remedy 项目教程

remedy RStudio Addins to Simplify Markdown Writing 项目地址: https://gitcode.com/gh_mirrors/re/remedy

1. 项目的目录结构及介绍

remedy 是一个为 RStudio 提供的 Markdown 编写辅助工具的开源项目。以下是项目的目录结构及其简单介绍：

• DESCRIPTION：项目描述文件，包含项目的名称、版本、作者、依赖等信息。
• LICENSE：项目许可证文件，本项目采用的开源许可证。
• NAMESPACE：R 包命名空间文件，定义了包的命名空间。
• README.Rmd：项目自述文件，使用 Markdown 格式编写，介绍了项目的用途、安装和使用方法。
• README.md：项目自述文件的纯文本版本，通常用于 GitHub 页面显示。
• .gitignore：Git 忽略文件，列出了在 Git 版本控制中应该被忽略的文件和目录。
• CONDUCT.md：项目行为准则文件，规定了项目贡献者的行为规范。
• remedy.Rproj：RStudio 项目文件，用于打开 RStudio 项目环境。
• inst/：包含项目安装时需要额外安装的文件，如数据文件、示例文件等。
• man/：包含项目文档的源文件，通常是 Rmd 文件。
• R/：包含项目 R 代码的目录。
• tests/：包含项目测试文件的目录。
• vignettes/：包含项目示例文档的目录。
• 其他文件和目录：可能包含项目的其他资源和文档。

2. 项目的启动文件介绍

remedy 项目的启动主要是通过 RStudio 的插件系统进行。用户需要先通过以下命令安装该项目：

remotes::install_github("ThinkR-open/remedy")

安装完毕后，用户不需要使用 library() 函数加载包，因为插件已经在安装过程中被集成到了 RStudio 的环境中。

3. 项目的配置文件介绍

remedy 项目的配置主要通过 remedy_opts 函数进行。以下是配置热键的示例：

hotkeys <- remedy::remedy_opts$get("hotkeys")
rsam::set_shortcut(sprintf('remedy::%sr', names(hotkeys)), hotkeys)

用户可以通过修改 hotkeys 对象来更改默认的热键设置。此外，项目还提供了一个 remedy_example() 函数，用户可以通过它来查看各个函数的行为示例。

项目的配置文件还包括 .Rbuildignore 文件，它用于指定在构建 R 包时不包括的文件和目录，以及 codecov.yml 文件，用于配置代码覆盖率的提交。

以上就是 remedy 项目的目录结构、启动文件和配置文件的简单介绍。用户可以通过阅读项目官方文档来获取更详细的信息和指导。

remedy RStudio Addins to Simplify Markdown Writing 项目地址: https://gitcode.com/gh_mirrors/re/remedy