RcppとRパッケージを統合：CPPコードオブジェクトのドキュメント

Question

私はC++統合のためにRcppでパッケージを開発しています。関数がSEXPオブジェクトを返すようにRcppExportを使用しました。

問題はtravis-ciが文書化されていないコードオブジェクトがあることを警告するようです。 （これらはcpp関数です）。しかし私は、ユーザーがこれらの機能に直接アクセスすることを望まない。

この問題を解決するにはどうすればよいですか？これらの機能をどのように文書化することができますか？

Answer 1

ここでは基本的な誤解があるようです。

あなたNAMESPACEはワイルドカードが含まれている場合、明らかは、ヘルプ項目を必要とする文書化されているラexportPattern("^[[:alpha:]]+")その後、各グローバルシンボルがエクスポートされあたりR規格「すべてをエクスポート」。

1つの簡単な修正では、すべてをエクスポートせず、エクスポートしたいドキュメントを作成するだけです。私たちは時々それを行い、foo_implのようなRcpp関数を呼び出し、R関数foo（ドキュメントあり）をfoo_implと呼ぶことがあります。その場合は、fooをエクスポートして、すべてが有効です。要するに

、あなたはRパッケージとあまりないRcppについて混乱しています。彼らが何をしているのかを感じるために、のソース（小）Rcppパッケージをダウンロードすることをお勧めします。