私はroxygenの使い方を学んでいます。rd ビネットでは、"_PACKAGE" を使用してパッケージ ドキュメントを作成していることを示すことを提唱し、「これは pkgname() という関数が既に存在する場合にも機能する」と述べています。
Rパッケージの本を使用するアプローチも見ました
NULL
@docType と @name が指定されているのですが、どちらのアプローチでもおもちゃの例を作ろうとすると、期待どおりに動作しません。
おもちゃの例として、「hello()」関数を含む「hello」パッケージを作成したいと思います。
私のhelloパッケージに関するドキュメントを取得することを期待しています
?hello
またはおそらく次のようなもの
package?hello
そして、含まれているhello関数に関するドキュメントを取得することを期待しています
?hello()
どこが間違っていますか？- roxygen を使用した実装、ドキュメントをクエリしようとしている方法、誤った期待、またはその他の何か?
パッケージ ドキュメントと関数ドキュメントに関する質問は既に確認しましたが、まだ不明な点があります。
私のおもちゃの例についての詳細は次のとおりです。
hello/DESCRIPTION ファイル:
Package: hello
Type: Package
Title: A mostly empty package
Version: 0.1
Date: 2016-06-21
Authors@R: person("Some", "Person", email = "fake@madeup.org", role = c("aut", "cre"))
Description: More about what it does (maybe more than one line)
License: MIT
LazyData: TRUE
RoxygenNote: 5.0.1.9000
こんにちは/R/こんにちは.R
#' hello
#'
#' This is a mostly empty package to learn roxygen documentation.
#'
#' Hello allows me to learn how to write documentation in comment blocks
#' co-located with code.
#' @docType package
#' @name hello
"_PACKAGE"
#' hello
#'
#' This function returns "Hello, world!".
#' @export
#' @examples
#' hello()
hello <- function() {
print("Hello, world!")
}
これで を実行するdocument()と、hello/man/hello.Rd が生成されます。これには、hello パッケージと hello() 関数について私が書いた説明の組み合わせが含まれています。どちらもその.Rdファイルを返します?hello。?hello()
.Rd は次のようになります。
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/hello.R
\docType{package}
\name{hello}
\alias{hello}
\alias{hello-package}
\title{hello}
\usage{
hello()
}
\description{
This is a mostly empty package to learn roxygen documentation.
This function returns "Hello, world!".
}
\details{
Hello allows me to learn how to write documentation in comment blocks
co-located with code.
}
\examples{
hello()
}