私のRコードのドキュメントを作成したいと思います。コードはRプロジェクトの一部ですが、パッケージではありません。完全なパッケージを作成せずに組み込みのヘルプビューアを使用して、パッケージに含まれていないコードのドキュメントを表示する方法はありますか?Rプロジェクトのドキュメントを作成します
3
A
答えて
11
コードファイルにドキュメントを直接保管しておけば、あなたの関数の上にある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
関連する問題
- 1. R:サブディレクトリとドキュメントを含むプロジェクトを作成する
- 2. C++プロジェクトのドキュメントを作成する方法は?
- 3. JythonプロジェクトでSphinxベースのドキュメントを作成するには?
- 4. メモリにドキュメントを作成しますか?
- 5. C#プロジェクトのインストールパッケージを作成します
- 6. NetOffice.Wordを使用してドキュメントを作成すると、追加の空白のドキュメントが作成されます
- 7. Intellijはgrailsプロジェクトを作成します
- 8. GWT Mavenプロジェクトを作成します。
- 9. Rプロジェクトを使用してムービーレーティングのベクトルマトリックスを作成する方法は?
- 10. C#プロジェクトとJavaプロジェクトのSandcastle統一されたドキュメント生成
- 11. ASP.NET/C#のxmlドキュメントからHTMLテーブルを作成しますか?
- 12. Windows上でGo 1のドキュメントを作成します。
- 13. XmlSerializerは空のドキュメントを作成しますか
- 14. ユーザーが作成したドキュメントをpowershellで検索しますか?
- 15. Rピボットテーブルを作成するR
- 16. %Rオーバーラップマトリックスを作成するR
- 17. ドキュメント比較ソフトウェアの作成
- 18. オブジェクトRでのショットチャートを作成中R
- 19. TypeDoc空のドキュメントを作成する
- 20. C#プロジェクト用のすべてのインラインXMLドキュメントを自動生成
- 21. 私のプロジェクトのPDFドキュメントを生成するには?
- 22. プログラムを作成するR
- 23. エリアプロットを作成するR
- 24. SOLR ..でドキュメントを作成していますか?
- 25. RでのCartogramの作成R
- 26. R:2つのモデルのループを作成していますか?
- 27. MacのR関数へのキーボードショートカットを作成しますか?
- 28. Rの列発生の合計を作成します。
- 29. プロジェクトまたはプロジェクトビルド用のJARを作成します
- 30. R&R:ステージ4:ランカーを作成して訓練する
確かに、私は同意するものとします。あなたは行くことができます。 – amarchin
コードを正しく文書化するには、パッケージを構築するよりも多大な努力が必要です。なぜ誰が前者をやるのか、後者はしないのか、私は本当に分かりません。 – Roland
@Roland私は精神で同意しますが、実際にはいくつかの人が異なるワークフローを持っています。彼らが完全なパッケージを作成するのに対応するためにワークフローを変更せずにドキュメントを書きたいと思えば、それは私にとっては大丈夫です。また、パッケージの作成はこれまでよりもずっと簡単だと思っていますが、以前はそれをやっていない人にとってはまだまだ大きなハードルです。 – Dason