**roxygen2/**: 如果使用roxygen2来生成文档,这个文件夹包含注释块。 这些文件和文件夹构成了R包的基本结构,确保包的功能性和可维护性。 函数文档: 为每个函数提供详细的文档,使用roxygen2自动生成文档。 依赖管理: 明确列出包的依赖关系,并在DESCRIPTION文件中指定。
如果你使用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:/
0 warnings ✓ | 1 note x 可以为函数加上一些帮助文档,文档放在man文件夹里面后缀是.Rd是Rmarkdown文件 写文档的时候可以直接在函数上面以标准格式的形式写注释,再使用roxygen2 可以将特定格式的注释转化成.Rd文件,roxygen2除了生成.Rd文件外还可以更改NAMESPACE和DESVRIPTION中的Collate字段 基本的流程有4步: 将roxygen格式的注释添加到 (10, 1) add <- function(x, y) { x + y } devtools::document() 现在man/add.Rd文件就生成了: % Generated by roxygen2 (a, b) { factor(c(as.character(a), as.character(b))) } 可以使用@tests和@testexamples tag来在注释中写测试代码 再运行roxygen2 (包括S4泛型函数) importClassesFrom(), importMethodsFrom(): 导入S4类和方法 useDynLib(): 从C导入一个函数 这些都是不需要手动改的,可以使用roxygen2
列表处理与迭代计算:purrr 统计建模:stats 与 broom 绘图:graphics 与 ggplot2 函数编程:apply家族和purrr等 开发: devtools usethis testthat roxygen2
{}} 使用方法见 https://shixiangwang.github.io/home/cn/post/2019-08-04-rlang-operator-curly-curly/ 包文档与测试 roxygen2
use_mit_license()` -> `MIT` license usethis::use_mit_license("xiongfeng chen") 添加函数帮助文档: man/*.Rd <- 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包的创建 预先准备 安装R包,需要执行以下代码: install.packages(c("devtools", "roxygen2", "testthat", "knitr")) install.packages
ggplot2, graphics, limma, lsmeans, methods, reshape2, spatstat, stats, survival, plyr Suggests: roxygen2
'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
roxygen2:通过注释的方式,生成文档,远离Latex的烦恼。
roxygen2:通过注释的方式,生成文档,远离Latex的烦恼。
RcppML", "readr", "reshape2", "reticulate", "rlang", "RMTstat", "RobustRankAggreg", "roxygen2 RcppML", "readr", "reshape2", "reticulate", "rlang", "RMTstat", "RobustRankAggreg", "roxygen2
roxygen2:通过注释的方式,生成文档,远离Latex的烦恼。