我正在编写许多函数,并且正在尝试使用roxygen2进行文档记录
我经常使用futile.logger程序包,比如说我flog.debug
在一个函数中使用该函数。我@*
应该用什么来记录它?
首先,要了解您的
sessionInfo()
getwd() # your R's working directory
.libPaths() # your R's library location
步骤0下载并安装必要的软件包:
library(roxygen2)
library(devtools)
library(digest)
步骤1将所有相关的“ .R”文件(yourfunction1.R,yourfunction2.R,yourfunction3.R)放入R的工作目录。
步骤2在R的工作目录中创建包框架:在运行以下命令之前,请确保R的工作目录中没有名为“ yourpackage”的文件夹。(从R的控制台开始)
package.skeleton(name = "yourpackage", code_files = c("yourfunction1.R", "yourfunction2.R", "yourfunction3.R"), path = ".")
运行后package.skeleton
,将在R的工作目录中创建yourpackage文件夹。
Read-and-delete-me
从Windows资源管理器中删除文件。
删除YourR'sWorkingDirectory \ yourpackage \ man文件夹中的“ yourpackage-package.Rd”文件
(请勿删除YourR'sWorkingDirectory \ yourpackage \ man文件夹中的“ yourpackage.Rd”文件!)
步骤3在“ .R”文件(yourfunction.R)的序言结尾处,放入以下内容(如果您在Step1中未这样做):
#' @importFrom futile.logger flog.debug
#' @export
yourfunction <- function(...) {...
步骤4在DESCRIPTION
包文件的Imports
部分中,添加:
Imports:
futile.logger(>= VersionNumber)
其中,VersionNumber是您正在使用的futile.logger程序包的版本号。可以通过在RevolutionREnterprise的对象浏览器中右键单击任何功能(从包装中)来找到版本号。然后转到生成的.html帮助文件的底部。在那里,显示了软件包的版本号。
在Step2中,package.skeleton自动生成一个NAMESPACE文件,其内容为:
exportPattern("^[[:alpha:]]+")
不要手动处理此NAMESPACE文件。
Step5充氧您要创建的包(“您的包”)
library(roxygen2)
roxygenize("yourpackage")
充氧后,您包裹的NAMESPACE文件的内容会自动从转换exportPattern("^[[:alpha:]]+")
为。
# Generated by roxygen2: do not edit by hand
export(yourfunction)
importFrom(futile.logger,flog.debug)
步骤6构建软件包:(
首先,从Windows资源管理器中删除YourR'sWorkingDirectoryFolder \ yourpackage文件夹中的“ src-i386”和“ src-x64”文件夹(如果有))
(再次确保没有“ yourpackage-package.Rd” “文件放在YourR'sWorkingDirectory \ yourpackage \ man文件夹中。如果存在,请在构建之前将其删除)
build("yourpackage")
Step7安装您的软件包:
install("yourpackage")
步骤8通过加载程序包并在程序包中运行功能来检查一切是否正常。
library(yourpackage)
yourfunction(6,1,2) # "yourfunction" is a function in the package "yourpackage"
步骤9检查您的软件包是否可加载到CRAN(综合R Archieve网络)(如果您想共享您的软件包):
(首先,从Windows资源管理器中删除YourR'sWorkingDirectoryFolder \ yourpackage文件夹中的“ src-i386”和“ src-x64”文件夹(如果有))
(再次确保YourR'中没有“ yourpackage-package.Rd”文件sWorkingDirectory \ yourpackage \ man文件夹。如果存在,请在检查之前将其删除)
在DOS命令提示符下:
开始– cmd-输入。传递到R的工作目录(可通过getwd()知道R的工作目录)并进行CRAN检查:
cd C:\Users\User\Documents\Revolution
R CMD check yourpackage
在R的控制台中:
devtools::check("C:/Users/User/Documents/Revolution/yourpackage")
本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句