Rプロジェクトのドキュメントを作成します

Question

私のRコードのドキュメントを作成したいと思います。コードはRプロジェクトの一部ですが、パッケージではありません。完全なパッケージを作成せずに組み込みのヘルプビューアを使用して、パッケージに含まれていないコードのドキュメントを表示する方法はありますか？

Answer 1

コードファイルにドキュメントを直接保管しておけば、あなたの関数の上にあるroxygenスタイルのコメントを使用することができます。あなたは簡単に典型的な?your_function構文を使ってあなたの文書を見ることができません。ドキュメンテーションを生成してヘルプ検索パスのどこかに置くためのいくつかのハッキングを回避する方法があるかもしれませんが、それは必要以上に多くの作業のようです。

パッケージをロードする場合は、関数内にroxygen2スタイルのドキュメントを含める場合は、?your_functionの構文を使用してドキュメントを表示することができます。これは、あなたが書類に書いてもらいたいのに、時間をかけずに、あるいはパッケージに入れる気にしていないコードを持っている、あなたのユースケースのために書いたパッケージです。 READMEをthe github page for docstringで読んだり、cran page for docstringに記載されているビネットをご覧ください。ここで

はドキュメンテーション文字列を使用してセッション例です：

library(docstring) 

square <- function(x){ 

    #' Square a number 
    #' 
    #' Calculates the square of the input 
    #' 
    #' @param x the input to be squared 

    return(x^2) 
} 

# This will display the documentation for square 
# just like any other help file would be displayed 
?square