33

roxygen2 で文書化しようとしている関数があります。

#' Name of function
#' 
#' Description
#' 
#' @param x The input data
#' @param method one of:
#' "method1" - very long text here 
#' "method2" - very long text here
#' "method3" - very long text here
#' "method4" - very long text here 
#' "method5" - very long text here 
#' "method6" - very long text here 
#' "method7" - very long text here 
#' "method8" - very long text here 
#' "method9" - very long text here 
#' "method10" - very long text here 
myfun <- function (x, method){return(NULL)}

この関数には約 10 の異なるメソッドがあり、それぞれに非常に長い説明があります。使用可能なさまざまなメソッドをすばやく簡単に確認できるように、各「メソッド」の間に改行が必要です。

書かれているように、 を呼び出すroxygenize('mypackage')と、上記のテキストが 1 行に圧縮されます。

roxygen2 ドキュメントに改行を手動で挿入するにはどうすればよいですか?

4

1 に答える 1

50

これは機能します：

#' Name of function
#' 
#' Description
#' 
#' @param x The input data
#' @param method one of: \cr 
#' "method1" - very long text here \cr 
#' "method2" - very long text here \cr 
#' "method3" - very long text here \cr 
#' "method4" - very long text here \cr 
#' "method5" - very long text here \cr 
#' "method6" - very long text here \cr 
#' "method7" - very long text here \cr 
#' "method8" - very long text here \cr 
#' "method9" - very long text here \cr 
#' "method10" - very long text here \cr 
myfun <- function (x, method){return(NULL)}

これは私が使用するレポの実際の例です\cr: https://github.com/trinker/SOdemoing/blob/master/R/FUN.R

また、@Gregor のコメントはよく取られています。それは次のようになります。 

#' @param method2 one of:
#' \itemize{
#'   \item method1 - very long text here 
#'   \item method2 - very long text here
#'   \item method3 - very long text here
#'   \item method4 - very long text here 
#'   \item method5 - very long text here 
#'   \item method6 - very long text here 
#'   \item method7 - very long text here 
#'   \item method8 - very long text here 
#'   \item method9 - very long text here 
#'   \item method10 - very long text here 
#' }

ここでは、両方の出力を確認できます。

ここに画像の説明を入力

私はGitHub リポジトリ SOdemoingを作成して、このようなこと (より複雑なパッケージ関連の質問と回答) をテストしました。両方のアプローチをテストするFUN.Rを参照してください。roxygen2次に、これをセットアップした結果のヘルプ マニュアルを参照してください(関数は FUN.R です)。

于 2014-06-11T14:34:55.507 に答える