包来生成.Rd文件 打开fbind.R文件,然后点击Code>Insert roxygen skeleton(注意,这个时候光标要在函数内部) 就可以插入模板了,可以在此基础上进行修改: ? License: MIT + file LICENSE Encoding: UTF-8 LazyData: true Roxygen: list(markdown = TRUE) RoxygenNote 可以将特定格式的注释转化成.Rd文件,roxygen2除了生成.Rd文件外还可以更改NAMESPACE和DESVRIPTION中的Collate字段 基本的流程有4步: 将roxygen格式的注释添加到 image-20200916144852749 Roxygen 注释 Roxygen注释以#'开头,并且在函数的前面;所有在函数前面的roxygen行叫做一个block,每一行不超过80个字符 block 来生成 基本流程是: 生成namespace和生成函数的document是一样的,在R代码前面使用roxygen块(以#'开头)和tags(以@开头) 基本流程为: 在.R文件前面加上roxygen注释
R包开发 创建R包基本流程: 开发工具:devtools 运行调试 + usethis 创建修改 基本流程: create_package 创建一个R包 use_r()写函数,插入roxygen注释和 use_mit_license()` -> `MIT` license usethis::use_mit_license("xiongfeng chen") 添加函数帮助文档: man/*.Rd <- roxygen2 包生成 fbind.R -> Code>Insert roxygen skeleton #' @examples #' fbind(iris$Species[c(1, 51, 101)], PlantGrowth
**roxygen2/**: 如果使用roxygen2来生成文档,这个文件夹包含注释块。 这些文件和文件夹构成了R包的基本结构,确保包的功能性和可维护性。 函数文档: 为每个函数提供详细的文档,使用roxygen2自动生成文档。 依赖管理: 明确列出包的依赖关系,并在DESCRIPTION文件中指定。
在RStudio中,你可以使用Roxygen注释来添加文档。 This is a parameter,然后使用"Tools" -> "Project Options" -> "Build Tools" -> "Generate documentation with Roxygen
如果你使用roxygen2[1],那么你可以利用注释代码块 #' @importFrom ggplot2 <one or more object names> (注意,这对数据集mpg不起作用)。 ggplot2", quietly = TRUE)) { vctrs::s3_register("ggplot2::autoplot", "discrete_distr") } } 参考资料 [1]roxygen2 : https://cran.r-project.org/package=roxygen2 [2]rlang: https://rlang.r-lib.org/ [3]ggdendro: https:/
列表处理与迭代计算:purrr 统计建模:stats 与 broom 绘图:graphics 与 ggplot2 函数编程:apply家族和purrr等 开发: devtools usethis testthat roxygen2
提高了代码的模块化和可维护性:新版GSVA包通过引入Roxygen注释和markdown文档,提高了代码的模块化和可维护性。
{}} 使用方法见 https://shixiangwang.github.io/home/cn/post/2019-08-04-rlang-operator-curly-curly/ 包文档与测试 roxygen2
准备 安装Rtools,RStudio install.packages(c("devtools", "roxygen2", "testthat", "knitr")) 创建包目录 打开RStudio
ggplotify","RANN","umap", "celldex","curl","httr","lattice","session","shinythemes","usethis","rcmdcheck", "roxygen2
'pillar', 'pkgload', 'plotrix', 'R6', 'RcppArmadillo', 'RCurl', 'remotes', 'rlang', 'rmarkdown', 'roxygen2
API (Scaladoc)scala文档 Spark Java API (Javadoc)java文档 Spark Python API (Sphinx)python文档 Spark R API (Roxygen2
R的Sphinx(sphinx-doc.org),perldoc,Javadoc和Roxygen(https://github.com/klutometis/roxygen)等软件可以生成文档,甚至可以阅读您的注释并使用它们生成详细的
R包的创建 预先准备 安装R包,需要执行以下代码: install.packages(c("devtools", "roxygen2", "testthat", "knitr")) install.packages
ggplot2, graphics, limma, lsmeans, methods, reshape2, spatstat, stats, survival, plyr Suggests: roxygen2
你还须确保你已安装以下几个包:quantmod、xts、roxygen2 和 devtools。 5. 从零开始编写你的第一个包 现在让我们开始创建一个简单的包。 现在检查 “Generatedocumentation with Roxygen”选项,并在 Check Package space 下放入“–as-cran”来模拟 CRAN 检查和测试包的操作。
'pillar', 'pkgload', 'plotrix', 'R6', 'RcppArmadillo', 'RCurl', 'remotes', 'rlang', 'rmarkdown', 'roxygen2
文档: Spark Scala API (Scaladoc) Spark Java API (Javadoc) Spark Python API (Sphinx) Spark R API (Roxygen2
RcppML", "readr", "reshape2", "reticulate", "rlang", "RMTstat", "RobustRankAggreg", "roxygen2
in the user library that you might not want as project-specific dependencies, e.g. devtools, knitr, roxygen2